@types/office-js 1.0.413 → 1.0.415

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.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +2453 -256
  3. office-js/package.json +2 -2
office-js/index.d.ts CHANGED
@@ -12695,10 +12695,16 @@ declare namespace Office {
12695
12695
  *
12696
12696
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12697
12697
  *
12698
- * **Important**: When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12698
+ * **Important**:
12699
+ *
12700
+ * - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12699
12701
  * be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
12700
12702
  * render efficiently with its rendering engine.
12701
12703
  *
12704
+ * - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
12705
+ * if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
12706
+ * Otherwise, you may receive an unexpected value, such as an empty string.
12707
+ *
12702
12708
  * @param coercionType - The format for the returned body.
12703
12709
  * @param options - An object literal that contains one or more of the following properties:-
12704
12710
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -12718,10 +12724,16 @@ declare namespace Office {
12718
12724
  *
12719
12725
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12720
12726
  *
12721
- * **Important**: When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12727
+ * **Important**:
12728
+ *
12729
+ * - When working with HTML-formatted bodies, it's important to note that the value returned by the `Body.getAsync` method won't necessarily
12722
12730
  * be the exact same value that was previously passed in the `Body.setAsync` method. The client may modify the value passed to `setAsync` to make it
12723
12731
  * render efficiently with its rendering engine.
12724
12732
  *
12733
+ * - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
12734
+ * if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
12735
+ * Otherwise, you may receive an unexpected value, such as an empty string.
12736
+ *
12725
12737
  * @param coercionType - The format for the returned body.
12726
12738
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
12727
12739
  * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
@@ -85839,9 +85851,9 @@ declare namespace Word {
85839
85851
  */
85840
85852
  untrack(): Word.AnnotationCollection;
85841
85853
  /**
85842
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
85843
- * Whereas the original `Word.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
85844
- */
85854
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
85855
+ * Whereas the original `Word.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
85856
+ */
85845
85857
  toJSON(): Word.Interfaces.AnnotationCollectionData;
85846
85858
  }
85847
85859
  /**
@@ -86292,6 +86304,208 @@ declare namespace Word {
86292
86304
  */
86293
86305
  toJSON(): Word.Interfaces.BodyData;
86294
86306
  }
86307
+ /**
86308
+ * Represents the Border object for text, a paragraph, or a table.
86309
+ *
86310
+ * @remarks
86311
+ * [Api set: WordApiDesktop 1.1]
86312
+ */
86313
+ class Border extends OfficeExtension.ClientObject {
86314
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
86315
+ context: RequestContext;
86316
+ /**
86317
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
86318
+ *
86319
+ * @remarks
86320
+ * [Api set: WordApiDesktop 1.1]
86321
+ */
86322
+ color: string;
86323
+ /**
86324
+ * Gets the location of the border.
86325
+ *
86326
+ * @remarks
86327
+ * [Api set: WordApiDesktop 1.1]
86328
+ */
86329
+ readonly location: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";
86330
+ /**
86331
+ * Specifies the border type for the border.
86332
+ *
86333
+ * @remarks
86334
+ * [Api set: WordApiDesktop 1.1]
86335
+ */
86336
+ 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";
86337
+ /**
86338
+ * Specifies whether the border is visible.
86339
+ *
86340
+ * @remarks
86341
+ * [Api set: WordApiDesktop 1.1]
86342
+ */
86343
+ visible: boolean;
86344
+ /**
86345
+ * Specifies the width for the border.
86346
+ *
86347
+ * @remarks
86348
+ * [Api set: WordApiDesktop 1.1]
86349
+ */
86350
+ width: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
86351
+ /**
86352
+ * 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.
86353
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
86354
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
86355
+ */
86356
+ set(properties: Interfaces.BorderUpdateData, options?: OfficeExtension.UpdateOptions): void;
86357
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
86358
+ set(properties: Word.Border): void;
86359
+ /**
86360
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86361
+ *
86362
+ * @param options Provides options for which properties of the object to load.
86363
+ */
86364
+ load(options?: Word.Interfaces.BorderLoadOptions): Word.Border;
86365
+ /**
86366
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86367
+ *
86368
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
86369
+ */
86370
+ load(propertyNames?: string | string[]): Word.Border;
86371
+ /**
86372
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86373
+ *
86374
+ * @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.
86375
+ */
86376
+ load(propertyNamesAndPaths?: {
86377
+ select?: string;
86378
+ expand?: string;
86379
+ }): Word.Border;
86380
+ /**
86381
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
86382
+ */
86383
+ track(): Word.Border;
86384
+ /**
86385
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
86386
+ */
86387
+ untrack(): Word.Border;
86388
+ /**
86389
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
86390
+ * Whereas the original `Word.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object.
86391
+ */
86392
+ toJSON(): Word.Interfaces.BorderData;
86393
+ }
86394
+ /**
86395
+ * Represents the collection of border styles.
86396
+ *
86397
+ * @remarks
86398
+ * [Api set: WordApiDesktop 1.1]
86399
+ */
86400
+ class BorderCollection extends OfficeExtension.ClientObject {
86401
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
86402
+ context: RequestContext;
86403
+ /** Gets the loaded child items in this collection. */
86404
+ readonly items: Word.Border[];
86405
+ /**
86406
+ * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
86407
+ *
86408
+ * @remarks
86409
+ * [Api set: WordApiDesktop 1.1]
86410
+ */
86411
+ insideBorderColor: string;
86412
+ /**
86413
+ * Specifies the border type of the inside borders.
86414
+ *
86415
+ * @remarks
86416
+ * [Api set: WordApiDesktop 1.1]
86417
+ */
86418
+ 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";
86419
+ /**
86420
+ * Specifies the width of the inside borders.
86421
+ *
86422
+ * @remarks
86423
+ * [Api set: WordApiDesktop 1.1]
86424
+ */
86425
+ insideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
86426
+ /**
86427
+ * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
86428
+ *
86429
+ * @remarks
86430
+ * [Api set: WordApiDesktop 1.1]
86431
+ */
86432
+ outsideBorderColor: string;
86433
+ /**
86434
+ * Specifies the border type of the outside borders.
86435
+ *
86436
+ * @remarks
86437
+ * [Api set: WordApiDesktop 1.1]
86438
+ */
86439
+ 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";
86440
+ /**
86441
+ * Specifies the width of the outside borders.
86442
+ *
86443
+ * @remarks
86444
+ * [Api set: WordApiDesktop 1.1]
86445
+ */
86446
+ outsideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
86447
+ /**
86448
+ * Gets the border that has the specified location.
86449
+ *
86450
+ * @remarks
86451
+ * [Api set: WordApiDesktop 1.1]
86452
+ */
86453
+ 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;
86454
+ /**
86455
+ * Gets the first border in this collection. Throws an `ItemNotFound` error if this collection is empty.
86456
+ *
86457
+ * @remarks
86458
+ * [Api set: WordApiDesktop 1.1]
86459
+ */
86460
+ getFirst(): Word.Border;
86461
+ /**
86462
+ * Gets the first border 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}.
86463
+ *
86464
+ * @remarks
86465
+ * [Api set: WordApiDesktop 1.1]
86466
+ */
86467
+ getFirstOrNullObject(): Word.Border;
86468
+ /**
86469
+ * Gets a Border object by its index in the collection.
86470
+ *
86471
+ * @remarks
86472
+ * [Api set: WordApiDesktop 1.1]
86473
+ *
86474
+ * @param index A number that identifies the index location of a Border object.
86475
+ */
86476
+ getItem(index: number): Word.Border;
86477
+ /**
86478
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86479
+ *
86480
+ * @param options Provides options for which properties of the object to load.
86481
+ */
86482
+ load(options?: Word.Interfaces.BorderCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BorderCollection;
86483
+ /**
86484
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86485
+ *
86486
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
86487
+ */
86488
+ load(propertyNames?: string | string[]): Word.BorderCollection;
86489
+ /**
86490
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
86491
+ *
86492
+ * @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.
86493
+ */
86494
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BorderCollection;
86495
+ /**
86496
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
86497
+ */
86498
+ track(): Word.BorderCollection;
86499
+ /**
86500
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
86501
+ */
86502
+ untrack(): Word.BorderCollection;
86503
+ /**
86504
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
86505
+ * Whereas the original `Word.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
86506
+ */
86507
+ toJSON(): Word.Interfaces.BorderCollectionData;
86508
+ }
86295
86509
  /**
86296
86510
  * The data specific to content controls of type CheckBox.
86297
86511
  *
@@ -86534,9 +86748,9 @@ declare namespace Word {
86534
86748
  */
86535
86749
  untrack(): Word.CommentCollection;
86536
86750
  /**
86537
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
86538
- * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
86539
- */
86751
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
86752
+ * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
86753
+ */
86540
86754
  toJSON(): Word.Interfaces.CommentCollectionData;
86541
86755
  }
86542
86756
  /**
@@ -86808,9 +87022,9 @@ declare namespace Word {
86808
87022
  */
86809
87023
  untrack(): Word.CommentReplyCollection;
86810
87024
  /**
86811
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
86812
- * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
86813
- */
87025
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
87026
+ * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87027
+ */
86814
87028
  toJSON(): Word.Interfaces.CommentReplyCollectionData;
86815
87029
  }
86816
87030
  /**
@@ -87472,9 +87686,9 @@ declare namespace Word {
87472
87686
  */
87473
87687
  untrack(): Word.ContentControlCollection;
87474
87688
  /**
87475
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
87476
- * Whereas the original `Word.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87477
- */
87689
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
87690
+ * Whereas the original `Word.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87691
+ */
87478
87692
  toJSON(): Word.Interfaces.ContentControlCollectionData;
87479
87693
  }
87480
87694
  /**
@@ -87654,9 +87868,9 @@ declare namespace Word {
87654
87868
  */
87655
87869
  untrack(): Word.CustomPropertyCollection;
87656
87870
  /**
87657
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
87658
- * Whereas the original `Word.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87659
- */
87871
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
87872
+ * Whereas the original `Word.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
87873
+ */
87660
87874
  toJSON(): Word.Interfaces.CustomPropertyCollectionData;
87661
87875
  }
87662
87876
  /**
@@ -88019,9 +88233,9 @@ declare namespace Word {
88019
88233
  */
88020
88234
  untrack(): Word.CustomXmlPartCollection;
88021
88235
  /**
88022
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
88023
- * Whereas the original `Word.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88024
- */
88236
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
88237
+ * Whereas the original `Word.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88238
+ */
88025
88239
  toJSON(): Word.Interfaces.CustomXmlPartCollectionData;
88026
88240
  }
88027
88241
  /**
@@ -88101,9 +88315,9 @@ declare namespace Word {
88101
88315
  */
88102
88316
  untrack(): Word.CustomXmlPartScopedCollection;
88103
88317
  /**
88104
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
88105
- * Whereas the original `Word.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88106
- */
88318
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
88319
+ * Whereas the original `Word.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
88320
+ */
88107
88321
  toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData;
88108
88322
  }
88109
88323
  /**
@@ -88221,6 +88435,16 @@ declare namespace Word {
88221
88435
  * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'.
88222
88436
  */
88223
88437
  close(closeBehavior?: "Save" | "SkipSave"): void;
88438
+ /**
88439
+ * Displays revision marks that indicate where the specified document differs from another document.
88440
+ *
88441
+ * @remarks
88442
+ * [Api set: WordApiDesktop 1.1]
88443
+ *
88444
+ * @param filePath Required. The path of the document with which the specified document is compared.
88445
+ * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document.
88446
+ */
88447
+ compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;
88224
88448
  /**
88225
88449
  * Deletes a bookmark, if it exists, from the document.
88226
88450
  *
@@ -88977,6 +89201,13 @@ declare namespace Word {
88977
89201
  * [Api set: WordApi 1.5]
88978
89202
  */
88979
89203
  locked: boolean;
89204
+ /**
89205
+ * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
89206
+ *
89207
+ * @remarks
89208
+ * [Api set: WordApiDesktop 1.1]
89209
+ */
89210
+ showCodes: boolean;
88980
89211
  /**
88981
89212
  * Gets the field's type.
88982
89213
  *
@@ -89140,9 +89371,9 @@ declare namespace Word {
89140
89371
  */
89141
89372
  untrack(): Word.FieldCollection;
89142
89373
  /**
89143
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
89144
- * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89145
- */
89374
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
89375
+ * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89376
+ */
89146
89377
  toJSON(): Word.Interfaces.FieldCollectionData;
89147
89378
  }
89148
89379
  /**
@@ -89360,6 +89591,13 @@ declare namespace Word {
89360
89591
  * [Api set: WordApi 1.1]
89361
89592
  */
89362
89593
  hyperlink: string;
89594
+ /**
89595
+ * Gets the format of the inline image.
89596
+ *
89597
+ * @remarks
89598
+ * [Api set: WordApiDesktop 1.1]
89599
+ */
89600
+ readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";
89363
89601
  /**
89364
89602
  * Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
89365
89603
  *
@@ -89603,9 +89841,9 @@ declare namespace Word {
89603
89841
  */
89604
89842
  untrack(): Word.InlinePictureCollection;
89605
89843
  /**
89606
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
89607
- * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89608
- */
89844
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
89845
+ * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89846
+ */
89609
89847
  toJSON(): Word.Interfaces.InlinePictureCollectionData;
89610
89848
  }
89611
89849
  /**
@@ -89645,6 +89883,15 @@ declare namespace Word {
89645
89883
  * [Api set: WordApi 1.3]
89646
89884
  */
89647
89885
  readonly levelTypes: Word.ListLevelType[];
89886
+ /**
89887
+ * Gets the font of the bullet, number, or picture at the specified level in the list.
89888
+ *
89889
+ * @remarks
89890
+ * [Api set: WordApiDesktop 1.1]
89891
+ *
89892
+ * @param level Required. The level in the list.
89893
+ */
89894
+ getLevelFont(level: number): Word.Font;
89648
89895
  /**
89649
89896
  * Gets the paragraphs that occur at the specified level in the list.
89650
89897
  *
@@ -89654,6 +89901,15 @@ declare namespace Word {
89654
89901
  * @param level Required. The level in the list.
89655
89902
  */
89656
89903
  getLevelParagraphs(level: number): Word.ParagraphCollection;
89904
+ /**
89905
+ * Gets the Base64-encoded string representation of the picture at the specified level in the list.
89906
+ *
89907
+ * @remarks
89908
+ * [Api set: WordApiDesktop 1.1]
89909
+ *
89910
+ * @param level Required. The level in the list.
89911
+ */
89912
+ getLevelPicture(level: number): OfficeExtension.ClientResult<string>;
89657
89913
  /**
89658
89914
  * Gets the bullet, number, or picture at the specified level as a string.
89659
89915
  *
@@ -89750,6 +90006,16 @@ declare namespace Word {
89750
90006
  * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number.
89751
90007
  */
89752
90008
  setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array<string | number>): void;
90009
+ /**
90010
+ * Sets the picture at the specified level in the list.
90011
+ *
90012
+ * @remarks
90013
+ * [Api set: WordApiDesktop 1.1]
90014
+ *
90015
+ * @param level Required. The level in the list.
90016
+ * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set.
90017
+ */
90018
+ setLevelPicture(level: number, base64EncodedImage?: string): void;
89753
90019
  /**
89754
90020
  * Sets the starting number at the specified level in the list. Default value is 1.
89755
90021
  *
@@ -89874,9 +90140,9 @@ declare namespace Word {
89874
90140
  */
89875
90141
  untrack(): Word.ListCollection;
89876
90142
  /**
89877
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
89878
- * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
89879
- */
90143
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
90144
+ * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
90145
+ */
89880
90146
  toJSON(): Word.Interfaces.ListCollectionData;
89881
90147
  }
89882
90148
  /**
@@ -89979,6 +90245,258 @@ declare namespace Word {
89979
90245
  */
89980
90246
  toJSON(): Word.Interfaces.ListItemData;
89981
90247
  }
90248
+ /**
90249
+ * Represents a list level.
90250
+ *
90251
+ * @remarks
90252
+ * [Api set: WordApiDesktop 1.1]
90253
+ */
90254
+ class ListLevel extends OfficeExtension.ClientObject {
90255
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
90256
+ context: RequestContext;
90257
+ /**
90258
+ * Gets a Font object that represents the character formatting of the specified object.
90259
+ *
90260
+ * @remarks
90261
+ * [Api set: WordApiDesktop 1.1]
90262
+ */
90263
+ readonly font: Word.Font;
90264
+ /**
90265
+ * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
90266
+ *
90267
+ * @remarks
90268
+ * [Api set: WordApiDesktop 1.1]
90269
+ */
90270
+ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
90271
+ /**
90272
+ * Specifies the name of the style that's linked to the specified list level object.
90273
+ *
90274
+ * @remarks
90275
+ * [Api set: WordApiDesktop 1.1]
90276
+ */
90277
+ linkedStyle: string;
90278
+ /**
90279
+ * Specifies the number format for the specified list level.
90280
+ *
90281
+ * @remarks
90282
+ * [Api set: WordApiDesktop 1.1]
90283
+ */
90284
+ numberFormat: string;
90285
+ /**
90286
+ * Specifies the position (in points) of the number or bullet for the specified list level object.
90287
+ *
90288
+ * @remarks
90289
+ * [Api set: WordApiDesktop 1.1]
90290
+ */
90291
+ numberPosition: number;
90292
+ /**
90293
+ * Specifies the number style for the list level object.
90294
+ *
90295
+ * @remarks
90296
+ * [Api set: WordApiDesktop 1.1]
90297
+ */
90298
+ numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ";
90299
+ /**
90300
+ * Specifies the list level that must appear before the specified list level restarts numbering at 1.
90301
+ *
90302
+ * @remarks
90303
+ * [Api set: WordApiDesktop 1.1]
90304
+ */
90305
+ resetOnHigher: number;
90306
+ /**
90307
+ * Specifies the starting number for the specified list level object.
90308
+ *
90309
+ * @remarks
90310
+ * [Api set: WordApiDesktop 1.1]
90311
+ */
90312
+ startAt: number;
90313
+ /**
90314
+ * Specifies the tab position for the specified list level object.
90315
+ *
90316
+ * @remarks
90317
+ * [Api set: WordApiDesktop 1.1]
90318
+ */
90319
+ tabPosition: number;
90320
+ /**
90321
+ * Specifies the position (in points) for the second line of wrapping text for the specified list level object.
90322
+ *
90323
+ * @remarks
90324
+ * [Api set: WordApiDesktop 1.1]
90325
+ */
90326
+ textPosition: number;
90327
+ /**
90328
+ * Specifies the character inserted after the number for the specified list level.
90329
+ *
90330
+ * @remarks
90331
+ * [Api set: WordApiDesktop 1.1]
90332
+ */
90333
+ trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone";
90334
+ /**
90335
+ * 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.
90336
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
90337
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
90338
+ */
90339
+ set(properties: Interfaces.ListLevelUpdateData, options?: OfficeExtension.UpdateOptions): void;
90340
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
90341
+ set(properties: Word.ListLevel): void;
90342
+ /**
90343
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90344
+ *
90345
+ * @param options Provides options for which properties of the object to load.
90346
+ */
90347
+ load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel;
90348
+ /**
90349
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90350
+ *
90351
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
90352
+ */
90353
+ load(propertyNames?: string | string[]): Word.ListLevel;
90354
+ /**
90355
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90356
+ *
90357
+ * @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.
90358
+ */
90359
+ load(propertyNamesAndPaths?: {
90360
+ select?: string;
90361
+ expand?: string;
90362
+ }): Word.ListLevel;
90363
+ /**
90364
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
90365
+ */
90366
+ track(): Word.ListLevel;
90367
+ /**
90368
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90369
+ */
90370
+ untrack(): Word.ListLevel;
90371
+ /**
90372
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
90373
+ * Whereas the original `Word.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object.
90374
+ */
90375
+ toJSON(): Word.Interfaces.ListLevelData;
90376
+ }
90377
+ /**
90378
+ * Contains a collection of {@link Word.ListLevel} objects.
90379
+ *
90380
+ * @remarks
90381
+ * [Api set: WordApiDesktop 1.1]
90382
+ */
90383
+ class ListLevelCollection extends OfficeExtension.ClientObject {
90384
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
90385
+ context: RequestContext;
90386
+ /** Gets the loaded child items in this collection. */
90387
+ readonly items: Word.ListLevel[];
90388
+ /**
90389
+ * Gets the first list level in this collection. Throws an `ItemNotFound` error if this collection is empty.
90390
+ *
90391
+ * @remarks
90392
+ * [Api set: WordApiDesktop 1.1]
90393
+ */
90394
+ getFirst(): Word.ListLevel;
90395
+ /**
90396
+ * Gets the first list level in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
90397
+ *
90398
+ * @remarks
90399
+ * [Api set: WordApiDesktop 1.1]
90400
+ */
90401
+ getFirstOrNullObject(): Word.ListLevel;
90402
+ /**
90403
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90404
+ *
90405
+ * @param options Provides options for which properties of the object to load.
90406
+ */
90407
+ load(options?: Word.Interfaces.ListLevelCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListLevelCollection;
90408
+ /**
90409
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90410
+ *
90411
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
90412
+ */
90413
+ load(propertyNames?: string | string[]): Word.ListLevelCollection;
90414
+ /**
90415
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90416
+ *
90417
+ * @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.
90418
+ */
90419
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListLevelCollection;
90420
+ /**
90421
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
90422
+ */
90423
+ track(): Word.ListLevelCollection;
90424
+ /**
90425
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90426
+ */
90427
+ untrack(): Word.ListLevelCollection;
90428
+ /**
90429
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
90430
+ * Whereas the original `Word.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
90431
+ */
90432
+ toJSON(): Word.Interfaces.ListLevelCollectionData;
90433
+ }
90434
+ /**
90435
+ * Represents a ListTemplate.
90436
+ *
90437
+ * @remarks
90438
+ * [Api set: WordApiDesktop 1.1]
90439
+ */
90440
+ class ListTemplate extends OfficeExtension.ClientObject {
90441
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
90442
+ context: RequestContext;
90443
+ /**
90444
+ * Gets a ListLevels collection that represents all the levels for the specified ListTemplate.
90445
+ *
90446
+ * @remarks
90447
+ * [Api set: WordApiDesktop 1.1]
90448
+ */
90449
+ readonly listLevels: Word.ListLevelCollection;
90450
+ /**
90451
+ * Specifies whether the specified ListTemplate object is outline numbered.
90452
+ *
90453
+ * @remarks
90454
+ * [Api set: WordApiDesktop 1.1]
90455
+ */
90456
+ outlineNumbered: boolean;
90457
+ /**
90458
+ * 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.
90459
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
90460
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
90461
+ */
90462
+ set(properties: Interfaces.ListTemplateUpdateData, options?: OfficeExtension.UpdateOptions): void;
90463
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
90464
+ set(properties: Word.ListTemplate): void;
90465
+ /**
90466
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90467
+ *
90468
+ * @param options Provides options for which properties of the object to load.
90469
+ */
90470
+ load(options?: Word.Interfaces.ListTemplateLoadOptions): Word.ListTemplate;
90471
+ /**
90472
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90473
+ *
90474
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
90475
+ */
90476
+ load(propertyNames?: string | string[]): Word.ListTemplate;
90477
+ /**
90478
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
90479
+ *
90480
+ * @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.
90481
+ */
90482
+ load(propertyNamesAndPaths?: {
90483
+ select?: string;
90484
+ expand?: string;
90485
+ }): Word.ListTemplate;
90486
+ /**
90487
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
90488
+ */
90489
+ track(): Word.ListTemplate;
90490
+ /**
90491
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
90492
+ */
90493
+ untrack(): Word.ListTemplate;
90494
+ /**
90495
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
90496
+ * Whereas the original `Word.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object.
90497
+ */
90498
+ toJSON(): Word.Interfaces.ListTemplateData;
90499
+ }
89982
90500
  /**
89983
90501
  * Represents a footnote or endnote.
89984
90502
  *
@@ -90125,9 +90643,9 @@ declare namespace Word {
90125
90643
  */
90126
90644
  untrack(): Word.NoteItemCollection;
90127
90645
  /**
90128
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
90129
- * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
90130
- */
90646
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
90647
+ * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
90648
+ */
90131
90649
  toJSON(): Word.Interfaces.NoteItemCollectionData;
90132
90650
  }
90133
90651
  /**
@@ -90802,9 +91320,9 @@ declare namespace Word {
90802
91320
  */
90803
91321
  untrack(): Word.ParagraphCollection;
90804
91322
  /**
90805
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
90806
- * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
90807
- */
91323
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
91324
+ * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
91325
+ */
90808
91326
  toJSON(): Word.Interfaces.ParagraphCollectionData;
90809
91327
  }
90810
91328
  /**
@@ -91634,9 +92152,9 @@ declare namespace Word {
91634
92152
  */
91635
92153
  untrack(): Word.RangeCollection;
91636
92154
  /**
91637
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
91638
- * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
91639
- */
92155
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
92156
+ * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92157
+ */
91640
92158
  toJSON(): Word.Interfaces.RangeCollectionData;
91641
92159
  }
91642
92160
  /**
@@ -91823,6 +92341,64 @@ declare namespace Word {
91823
92341
  */
91824
92342
  includeTextMarkedAsDeleted?: boolean;
91825
92343
  }
92344
+ /**
92345
+ * Specifies the options to be included in a compare document operation.
92346
+ *
92347
+ * @remarks
92348
+ * [Api set: WordApiDesktop 1.1]
92349
+ */
92350
+ interface DocumentCompareOptions {
92351
+ /**
92352
+ * True adds the document to the list of recently used files on the File menu. The default value is True.
92353
+ *
92354
+ * @remarks
92355
+ * [Api set: WordApiDesktop 1.1]
92356
+ */
92357
+ addToRecentFiles?: boolean;
92358
+ /**
92359
+ * The reviewer name associated with the differences generated by the comparison.
92360
+ If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present.
92361
+ *
92362
+ * @remarks
92363
+ * [Api set: WordApiDesktop 1.1]
92364
+ */
92365
+ authorName?: string;
92366
+ /**
92367
+ * The target document for the comparison. Default value is 'CompareTargetCurrent'.
92368
+ *
92369
+ * @remarks
92370
+ * [Api set: WordApiDesktop 1.1]
92371
+ */
92372
+ compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";
92373
+ /**
92374
+ * True (default) for the comparison to include detection of format changes.
92375
+ *
92376
+ * @remarks
92377
+ * [Api set: WordApiDesktop 1.1]
92378
+ */
92379
+ detectFormatChanges?: boolean;
92380
+ /**
92381
+ * True compares the documents without notifying a user of problems. The default value is False.
92382
+ *
92383
+ * @remarks
92384
+ * [Api set: WordApiDesktop 1.1]
92385
+ */
92386
+ ignoreAllComparisonWarnings?: boolean;
92387
+ /**
92388
+ * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False.
92389
+ *
92390
+ * @remarks
92391
+ * [Api set: WordApiDesktop 1.1]
92392
+ */
92393
+ removeDateAndTime?: boolean;
92394
+ /**
92395
+ * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False.
92396
+ *
92397
+ * @remarks
92398
+ * [Api set: WordApiDesktop 1.1]
92399
+ */
92400
+ removePersonalInformation?: boolean;
92401
+ }
91826
92402
  /**
91827
92403
  * Represents a section in a Word document.
91828
92404
  *
@@ -91984,9 +92560,9 @@ declare namespace Word {
91984
92560
  */
91985
92561
  untrack(): Word.SectionCollection;
91986
92562
  /**
91987
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
91988
- * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
91989
- */
92563
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
92564
+ * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92565
+ */
91990
92566
  toJSON(): Word.Interfaces.SectionCollectionData;
91991
92567
  }
91992
92568
  /**
@@ -92142,9 +92718,9 @@ declare namespace Word {
92142
92718
  */
92143
92719
  untrack(): Word.SettingCollection;
92144
92720
  /**
92145
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
92146
- * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92147
- */
92721
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
92722
+ * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92723
+ */
92148
92724
  toJSON(): Word.Interfaces.SettingCollectionData;
92149
92725
  }
92150
92726
  /**
@@ -92219,9 +92795,9 @@ declare namespace Word {
92219
92795
  */
92220
92796
  untrack(): Word.StyleCollection;
92221
92797
  /**
92222
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
92223
- * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92224
- */
92798
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
92799
+ * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
92800
+ */
92225
92801
  toJSON(): Word.Interfaces.StyleCollectionData;
92226
92802
  }
92227
92803
  /**
@@ -92233,6 +92809,13 @@ declare namespace Word {
92233
92809
  class Style extends OfficeExtension.ClientObject {
92234
92810
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
92235
92811
  context: RequestContext;
92812
+ /**
92813
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
92814
+ *
92815
+ * @remarks
92816
+ * [Api set: WordApiDesktop 1.1]
92817
+ */
92818
+ readonly borders: Word.BorderCollection;
92236
92819
  /**
92237
92820
  * Gets a font object that represents the character formatting of the specified style.
92238
92821
  *
@@ -92240,6 +92823,13 @@ declare namespace Word {
92240
92823
  * [Api set: WordApi 1.5]
92241
92824
  */
92242
92825
  readonly font: Word.Font;
92826
+ /**
92827
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
92828
+ *
92829
+ * @remarks
92830
+ * [Api set: WordApiDesktop 1.1]
92831
+ */
92832
+ readonly listTemplate: Word.ListTemplate;
92243
92833
  /**
92244
92834
  * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
92245
92835
  *
@@ -92408,6 +92998,20 @@ declare namespace Word {
92408
92998
  * [Api set: WordApi 1.6]
92409
92999
  */
92410
93000
  backgroundPatternColor: string;
93001
+ /**
93002
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
93003
+ *
93004
+ * @remarks
93005
+ * [Api set: WordApiDesktop 1.1]
93006
+ */
93007
+ foregroundPatternColor: string;
93008
+ /**
93009
+ * 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}.
93010
+ *
93011
+ * @remarks
93012
+ * [Api set: WordApiDesktop 1.1]
93013
+ */
93014
+ texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
92411
93015
  /**
92412
93016
  * 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.
92413
93017
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
@@ -92996,6 +93600,20 @@ declare namespace Word {
92996
93600
  class TableStyle extends OfficeExtension.ClientObject {
92997
93601
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
92998
93602
  context: RequestContext;
93603
+ /**
93604
+ * Specifies the table's alignment against the page margin.
93605
+ *
93606
+ * @remarks
93607
+ * [Api set: WordApiDesktop 1.1]
93608
+ */
93609
+ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
93610
+ /**
93611
+ * Specifies whether lines in tables formatted with a specified style break across pages.
93612
+ *
93613
+ * @remarks
93614
+ * [Api set: WordApiDesktop 1.1]
93615
+ */
93616
+ allowBreakAcrossPage: boolean;
92999
93617
  /**
93000
93618
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
93001
93619
  *
@@ -93126,9 +93744,9 @@ declare namespace Word {
93126
93744
  */
93127
93745
  untrack(): Word.TableCollection;
93128
93746
  /**
93129
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
93130
- * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
93131
- */
93747
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
93748
+ * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
93749
+ */
93132
93750
  toJSON(): Word.Interfaces.TableCollectionData;
93133
93751
  }
93134
93752
  /**
@@ -93310,6 +93928,13 @@ declare namespace Word {
93310
93928
  * [Api set: WordApi 1.3]
93311
93929
  */
93312
93930
  getNextOrNullObject(): Word.TableRow;
93931
+ /**
93932
+ * Inserts a content control on the row.
93933
+ *
93934
+ * @remarks
93935
+ * [Api set: WordApiDesktop 1.1]
93936
+ */
93937
+ insertContentControl(): Word.ContentControl;
93313
93938
  /**
93314
93939
  * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows.
93315
93940
  *
@@ -93471,9 +94096,9 @@ declare namespace Word {
93471
94096
  */
93472
94097
  untrack(): Word.TableRowCollection;
93473
94098
  /**
93474
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
93475
- * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
93476
- */
94099
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
94100
+ * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94101
+ */
93477
94102
  toJSON(): Word.Interfaces.TableRowCollectionData;
93478
94103
  }
93479
94104
  /**
@@ -93773,9 +94398,9 @@ declare namespace Word {
93773
94398
  */
93774
94399
  untrack(): Word.TableCellCollection;
93775
94400
  /**
93776
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
93777
- * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
93778
- */
94401
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
94402
+ * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94403
+ */
93779
94404
  toJSON(): Word.Interfaces.TableCellCollectionData;
93780
94405
  }
93781
94406
  /**
@@ -94024,9 +94649,9 @@ declare namespace Word {
94024
94649
  */
94025
94650
  untrack(): Word.TrackedChangeCollection;
94026
94651
  /**
94027
- * Overrides the JavaScript `toJSON()` method in order to provide 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.)
94028
- * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94029
- */
94652
+ * Overrides the JavaScript `toJSON()` method in order to provide 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.)
94653
+ * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94654
+ */
94030
94655
  toJSON(): Word.Interfaces.TrackedChangeCollectionData;
94031
94656
  }
94032
94657
  /**
@@ -95009,6 +95634,82 @@ declare namespace Word {
95009
95634
  */
95010
95635
  end = "End",
95011
95636
  }
95637
+ /**
95638
+ * @remarks
95639
+ * [Api set: WordApiDesktop 1.1]
95640
+ */
95641
+ enum ImageFormat {
95642
+ /**
95643
+ * @remarks
95644
+ * [Api set: WordApiDesktop 1.1]
95645
+ */
95646
+ unsupported = "Unsupported",
95647
+ /**
95648
+ * @remarks
95649
+ * [Api set: WordApiDesktop 1.1]
95650
+ */
95651
+ undefined = "Undefined",
95652
+ /**
95653
+ * @remarks
95654
+ * [Api set: WordApiDesktop 1.1]
95655
+ */
95656
+ bmp = "Bmp",
95657
+ /**
95658
+ * @remarks
95659
+ * [Api set: WordApiDesktop 1.1]
95660
+ */
95661
+ jpeg = "Jpeg",
95662
+ /**
95663
+ * @remarks
95664
+ * [Api set: WordApiDesktop 1.1]
95665
+ */
95666
+ gif = "Gif",
95667
+ /**
95668
+ * @remarks
95669
+ * [Api set: WordApiDesktop 1.1]
95670
+ */
95671
+ tiff = "Tiff",
95672
+ /**
95673
+ * @remarks
95674
+ * [Api set: WordApiDesktop 1.1]
95675
+ */
95676
+ png = "Png",
95677
+ /**
95678
+ * @remarks
95679
+ * [Api set: WordApiDesktop 1.1]
95680
+ */
95681
+ icon = "Icon",
95682
+ /**
95683
+ * @remarks
95684
+ * [Api set: WordApiDesktop 1.1]
95685
+ */
95686
+ exif = "Exif",
95687
+ /**
95688
+ * @remarks
95689
+ * [Api set: WordApiDesktop 1.1]
95690
+ */
95691
+ wmf = "Wmf",
95692
+ /**
95693
+ * @remarks
95694
+ * [Api set: WordApiDesktop 1.1]
95695
+ */
95696
+ emf = "Emf",
95697
+ /**
95698
+ * @remarks
95699
+ * [Api set: WordApiDesktop 1.1]
95700
+ */
95701
+ pict = "Pict",
95702
+ /**
95703
+ * @remarks
95704
+ * [Api set: WordApiDesktop 1.1]
95705
+ */
95706
+ pdf = "Pdf",
95707
+ /**
95708
+ * @remarks
95709
+ * [Api set: WordApiDesktop 1.1]
95710
+ */
95711
+ svg = "Svg",
95712
+ }
95012
95713
  /**
95013
95714
  * @remarks
95014
95715
  * [Api set: WordApi 1.3]
@@ -95218,6 +95919,80 @@ declare namespace Word {
95218
95919
  */
95219
95920
  right = "Right",
95220
95921
  }
95922
+ /**
95923
+ * Represents the width of a style's border.
95924
+ *
95925
+ * @remarks
95926
+ * [Api set: WordApiDesktop 1.1]
95927
+ */
95928
+ enum BorderWidth {
95929
+ /**
95930
+ * None width.
95931
+ * @remarks
95932
+ * [Api set: WordApiDesktop 1.1]
95933
+ */
95934
+ none = "None",
95935
+ /**
95936
+ * 0.25 point.
95937
+ * @remarks
95938
+ * [Api set: WordApiDesktop 1.1]
95939
+ */
95940
+ pt025 = "Pt025",
95941
+ /**
95942
+ * 0.50 point.
95943
+ * @remarks
95944
+ * [Api set: WordApiDesktop 1.1]
95945
+ */
95946
+ pt050 = "Pt050",
95947
+ /**
95948
+ * 0.75 point.
95949
+ * @remarks
95950
+ * [Api set: WordApiDesktop 1.1]
95951
+ */
95952
+ pt075 = "Pt075",
95953
+ /**
95954
+ * 1.00 point. This is the default.
95955
+ * @remarks
95956
+ * [Api set: WordApiDesktop 1.1]
95957
+ */
95958
+ pt100 = "Pt100",
95959
+ /**
95960
+ * 1.50 points.
95961
+ * @remarks
95962
+ * [Api set: WordApiDesktop 1.1]
95963
+ */
95964
+ pt150 = "Pt150",
95965
+ /**
95966
+ * 2.25 points.
95967
+ * @remarks
95968
+ * [Api set: WordApiDesktop 1.1]
95969
+ */
95970
+ pt225 = "Pt225",
95971
+ /**
95972
+ * 3.00 points.
95973
+ * @remarks
95974
+ * [Api set: WordApiDesktop 1.1]
95975
+ */
95976
+ pt300 = "Pt300",
95977
+ /**
95978
+ * 4.50 points.
95979
+ * @remarks
95980
+ * [Api set: WordApiDesktop 1.1]
95981
+ */
95982
+ pt450 = "Pt450",
95983
+ /**
95984
+ * 6.00 points.
95985
+ * @remarks
95986
+ * [Api set: WordApiDesktop 1.1]
95987
+ */
95988
+ pt600 = "Pt600",
95989
+ /**
95990
+ * Mixed width.
95991
+ * @remarks
95992
+ * [Api set: WordApiDesktop 1.1]
95993
+ */
95994
+ mixed = "Mixed",
95995
+ }
95221
95996
  /**
95222
95997
  * @remarks
95223
95998
  * [Api set: WordApi 1.3]
@@ -96978,6 +97753,634 @@ declare namespace Word {
96978
97753
  */
96979
97754
  cold = "Cold",
96980
97755
  }
97756
+ /**
97757
+ * Represents the character inserted after the list item mark.
97758
+ *
97759
+ * @remarks
97760
+ * [Api set: WordApiDesktop 1.1]
97761
+ */
97762
+ enum TrailingCharacter {
97763
+ /**
97764
+ * A tab is inserted.
97765
+ * @remarks
97766
+ * [Api set: WordApiDesktop 1.1]
97767
+ */
97768
+ trailingTab = "TrailingTab",
97769
+ /**
97770
+ * A space is inserted. Default.
97771
+ * @remarks
97772
+ * [Api set: WordApiDesktop 1.1]
97773
+ */
97774
+ trailingSpace = "TrailingSpace",
97775
+ /**
97776
+ * No character is inserted.
97777
+ * @remarks
97778
+ * [Api set: WordApiDesktop 1.1]
97779
+ */
97780
+ trailingNone = "TrailingNone",
97781
+ }
97782
+ /**
97783
+ * @remarks
97784
+ * [Api set: WordApiDesktop 1.1]
97785
+ */
97786
+ enum ListBuiltInNumberStyle {
97787
+ /**
97788
+ * @remarks
97789
+ * [Api set: WordApiDesktop 1.1]
97790
+ */
97791
+ none = "None",
97792
+ /**
97793
+ * @remarks
97794
+ * [Api set: WordApiDesktop 1.1]
97795
+ */
97796
+ arabic = "Arabic",
97797
+ /**
97798
+ * @remarks
97799
+ * [Api set: WordApiDesktop 1.1]
97800
+ */
97801
+ upperRoman = "UpperRoman",
97802
+ /**
97803
+ * @remarks
97804
+ * [Api set: WordApiDesktop 1.1]
97805
+ */
97806
+ lowerRoman = "LowerRoman",
97807
+ /**
97808
+ * @remarks
97809
+ * [Api set: WordApiDesktop 1.1]
97810
+ */
97811
+ upperLetter = "UpperLetter",
97812
+ /**
97813
+ * @remarks
97814
+ * [Api set: WordApiDesktop 1.1]
97815
+ */
97816
+ lowerLetter = "LowerLetter",
97817
+ /**
97818
+ * @remarks
97819
+ * [Api set: WordApiDesktop 1.1]
97820
+ */
97821
+ ordinal = "Ordinal",
97822
+ /**
97823
+ * @remarks
97824
+ * [Api set: WordApiDesktop 1.1]
97825
+ */
97826
+ cardinalText = "CardinalText",
97827
+ /**
97828
+ * @remarks
97829
+ * [Api set: WordApiDesktop 1.1]
97830
+ */
97831
+ ordinalText = "OrdinalText",
97832
+ /**
97833
+ * @remarks
97834
+ * [Api set: WordApiDesktop 1.1]
97835
+ */
97836
+ kanji = "Kanji",
97837
+ /**
97838
+ * @remarks
97839
+ * [Api set: WordApiDesktop 1.1]
97840
+ */
97841
+ kanjiDigit = "KanjiDigit",
97842
+ /**
97843
+ * @remarks
97844
+ * [Api set: WordApiDesktop 1.1]
97845
+ */
97846
+ aiueoHalfWidth = "AiueoHalfWidth",
97847
+ /**
97848
+ * @remarks
97849
+ * [Api set: WordApiDesktop 1.1]
97850
+ */
97851
+ irohaHalfWidth = "IrohaHalfWidth",
97852
+ /**
97853
+ * @remarks
97854
+ * [Api set: WordApiDesktop 1.1]
97855
+ */
97856
+ arabicFullWidth = "ArabicFullWidth",
97857
+ /**
97858
+ * @remarks
97859
+ * [Api set: WordApiDesktop 1.1]
97860
+ */
97861
+ kanjiTraditional = "KanjiTraditional",
97862
+ /**
97863
+ * @remarks
97864
+ * [Api set: WordApiDesktop 1.1]
97865
+ */
97866
+ kanjiTraditional2 = "KanjiTraditional2",
97867
+ /**
97868
+ * @remarks
97869
+ * [Api set: WordApiDesktop 1.1]
97870
+ */
97871
+ numberInCircle = "NumberInCircle",
97872
+ /**
97873
+ * @remarks
97874
+ * [Api set: WordApiDesktop 1.1]
97875
+ */
97876
+ aiueo = "Aiueo",
97877
+ /**
97878
+ * @remarks
97879
+ * [Api set: WordApiDesktop 1.1]
97880
+ */
97881
+ iroha = "Iroha",
97882
+ /**
97883
+ * @remarks
97884
+ * [Api set: WordApiDesktop 1.1]
97885
+ */
97886
+ arabicLZ = "ArabicLZ",
97887
+ /**
97888
+ * @remarks
97889
+ * [Api set: WordApiDesktop 1.1]
97890
+ */
97891
+ bullet = "Bullet",
97892
+ /**
97893
+ * @remarks
97894
+ * [Api set: WordApiDesktop 1.1]
97895
+ */
97896
+ ganada = "Ganada",
97897
+ /**
97898
+ * @remarks
97899
+ * [Api set: WordApiDesktop 1.1]
97900
+ */
97901
+ chosung = "Chosung",
97902
+ /**
97903
+ * @remarks
97904
+ * [Api set: WordApiDesktop 1.1]
97905
+ */
97906
+ gbnum1 = "GBNum1",
97907
+ /**
97908
+ * @remarks
97909
+ * [Api set: WordApiDesktop 1.1]
97910
+ */
97911
+ gbnum2 = "GBNum2",
97912
+ /**
97913
+ * @remarks
97914
+ * [Api set: WordApiDesktop 1.1]
97915
+ */
97916
+ gbnum3 = "GBNum3",
97917
+ /**
97918
+ * @remarks
97919
+ * [Api set: WordApiDesktop 1.1]
97920
+ */
97921
+ gbnum4 = "GBNum4",
97922
+ /**
97923
+ * @remarks
97924
+ * [Api set: WordApiDesktop 1.1]
97925
+ */
97926
+ zodiac1 = "Zodiac1",
97927
+ /**
97928
+ * @remarks
97929
+ * [Api set: WordApiDesktop 1.1]
97930
+ */
97931
+ zodiac2 = "Zodiac2",
97932
+ /**
97933
+ * @remarks
97934
+ * [Api set: WordApiDesktop 1.1]
97935
+ */
97936
+ zodiac3 = "Zodiac3",
97937
+ /**
97938
+ * @remarks
97939
+ * [Api set: WordApiDesktop 1.1]
97940
+ */
97941
+ tradChinNum1 = "TradChinNum1",
97942
+ /**
97943
+ * @remarks
97944
+ * [Api set: WordApiDesktop 1.1]
97945
+ */
97946
+ tradChinNum2 = "TradChinNum2",
97947
+ /**
97948
+ * @remarks
97949
+ * [Api set: WordApiDesktop 1.1]
97950
+ */
97951
+ tradChinNum3 = "TradChinNum3",
97952
+ /**
97953
+ * @remarks
97954
+ * [Api set: WordApiDesktop 1.1]
97955
+ */
97956
+ tradChinNum4 = "TradChinNum4",
97957
+ /**
97958
+ * @remarks
97959
+ * [Api set: WordApiDesktop 1.1]
97960
+ */
97961
+ simpChinNum1 = "SimpChinNum1",
97962
+ /**
97963
+ * @remarks
97964
+ * [Api set: WordApiDesktop 1.1]
97965
+ */
97966
+ simpChinNum2 = "SimpChinNum2",
97967
+ /**
97968
+ * @remarks
97969
+ * [Api set: WordApiDesktop 1.1]
97970
+ */
97971
+ simpChinNum3 = "SimpChinNum3",
97972
+ /**
97973
+ * @remarks
97974
+ * [Api set: WordApiDesktop 1.1]
97975
+ */
97976
+ simpChinNum4 = "SimpChinNum4",
97977
+ /**
97978
+ * @remarks
97979
+ * [Api set: WordApiDesktop 1.1]
97980
+ */
97981
+ hanjaRead = "HanjaRead",
97982
+ /**
97983
+ * @remarks
97984
+ * [Api set: WordApiDesktop 1.1]
97985
+ */
97986
+ hanjaReadDigit = "HanjaReadDigit",
97987
+ /**
97988
+ * @remarks
97989
+ * [Api set: WordApiDesktop 1.1]
97990
+ */
97991
+ hangul = "Hangul",
97992
+ /**
97993
+ * @remarks
97994
+ * [Api set: WordApiDesktop 1.1]
97995
+ */
97996
+ hanja = "Hanja",
97997
+ /**
97998
+ * @remarks
97999
+ * [Api set: WordApiDesktop 1.1]
98000
+ */
98001
+ hebrew1 = "Hebrew1",
98002
+ /**
98003
+ * @remarks
98004
+ * [Api set: WordApiDesktop 1.1]
98005
+ */
98006
+ arabic1 = "Arabic1",
98007
+ /**
98008
+ * @remarks
98009
+ * [Api set: WordApiDesktop 1.1]
98010
+ */
98011
+ hebrew2 = "Hebrew2",
98012
+ /**
98013
+ * @remarks
98014
+ * [Api set: WordApiDesktop 1.1]
98015
+ */
98016
+ arabic2 = "Arabic2",
98017
+ /**
98018
+ * @remarks
98019
+ * [Api set: WordApiDesktop 1.1]
98020
+ */
98021
+ hindiLetter1 = "HindiLetter1",
98022
+ /**
98023
+ * @remarks
98024
+ * [Api set: WordApiDesktop 1.1]
98025
+ */
98026
+ hindiLetter2 = "HindiLetter2",
98027
+ /**
98028
+ * @remarks
98029
+ * [Api set: WordApiDesktop 1.1]
98030
+ */
98031
+ hindiArabic = "HindiArabic",
98032
+ /**
98033
+ * @remarks
98034
+ * [Api set: WordApiDesktop 1.1]
98035
+ */
98036
+ hindiCardinalText = "HindiCardinalText",
98037
+ /**
98038
+ * @remarks
98039
+ * [Api set: WordApiDesktop 1.1]
98040
+ */
98041
+ thaiLetter = "ThaiLetter",
98042
+ /**
98043
+ * @remarks
98044
+ * [Api set: WordApiDesktop 1.1]
98045
+ */
98046
+ thaiArabic = "ThaiArabic",
98047
+ /**
98048
+ * @remarks
98049
+ * [Api set: WordApiDesktop 1.1]
98050
+ */
98051
+ thaiCardinalText = "ThaiCardinalText",
98052
+ /**
98053
+ * @remarks
98054
+ * [Api set: WordApiDesktop 1.1]
98055
+ */
98056
+ vietCardinalText = "VietCardinalText",
98057
+ /**
98058
+ * @remarks
98059
+ * [Api set: WordApiDesktop 1.1]
98060
+ */
98061
+ lowercaseRussian = "LowercaseRussian",
98062
+ /**
98063
+ * @remarks
98064
+ * [Api set: WordApiDesktop 1.1]
98065
+ */
98066
+ uppercaseRussian = "UppercaseRussian",
98067
+ /**
98068
+ * @remarks
98069
+ * [Api set: WordApiDesktop 1.1]
98070
+ */
98071
+ lowercaseGreek = "LowercaseGreek",
98072
+ /**
98073
+ * @remarks
98074
+ * [Api set: WordApiDesktop 1.1]
98075
+ */
98076
+ uppercaseGreek = "UppercaseGreek",
98077
+ /**
98078
+ * @remarks
98079
+ * [Api set: WordApiDesktop 1.1]
98080
+ */
98081
+ arabicLZ2 = "ArabicLZ2",
98082
+ /**
98083
+ * @remarks
98084
+ * [Api set: WordApiDesktop 1.1]
98085
+ */
98086
+ arabicLZ3 = "ArabicLZ3",
98087
+ /**
98088
+ * @remarks
98089
+ * [Api set: WordApiDesktop 1.1]
98090
+ */
98091
+ arabicLZ4 = "ArabicLZ4",
98092
+ /**
98093
+ * @remarks
98094
+ * [Api set: WordApiDesktop 1.1]
98095
+ */
98096
+ lowercaseTurkish = "LowercaseTurkish",
98097
+ /**
98098
+ * @remarks
98099
+ * [Api set: WordApiDesktop 1.1]
98100
+ */
98101
+ uppercaseTurkish = "UppercaseTurkish",
98102
+ /**
98103
+ * @remarks
98104
+ * [Api set: WordApiDesktop 1.1]
98105
+ */
98106
+ lowercaseBulgarian = "LowercaseBulgarian",
98107
+ /**
98108
+ * @remarks
98109
+ * [Api set: WordApiDesktop 1.1]
98110
+ */
98111
+ uppercaseBulgarian = "UppercaseBulgarian",
98112
+ /**
98113
+ * @remarks
98114
+ * [Api set: WordApiDesktop 1.1]
98115
+ */
98116
+ pictureBullet = "PictureBullet",
98117
+ /**
98118
+ * @remarks
98119
+ * [Api set: WordApiDesktop 1.1]
98120
+ */
98121
+ legal = "Legal",
98122
+ /**
98123
+ * @remarks
98124
+ * [Api set: WordApiDesktop 1.1]
98125
+ */
98126
+ legalLZ = "LegalLZ",
98127
+ }
98128
+ /**
98129
+ * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
98130
+ *
98131
+ * @remarks
98132
+ * [Api set: WordApiDesktop 1.1]
98133
+ */
98134
+ enum ShadingTextureType {
98135
+ /**
98136
+ * Represents dark diagonal-down texture.
98137
+ * @remarks
98138
+ * [Api set: WordApiDesktop 1.1]
98139
+ */
98140
+ darkDiagonalDown = "DarkDiagonalDown",
98141
+ /**
98142
+ * Represents dark diagonal-up texture.
98143
+ * @remarks
98144
+ * [Api set: WordApiDesktop 1.1]
98145
+ */
98146
+ darkDiagonalUp = "DarkDiagonalUp",
98147
+ /**
98148
+ * Represents dark horizontal-cross texture.
98149
+ * @remarks
98150
+ * [Api set: WordApiDesktop 1.1]
98151
+ */
98152
+ darkGrid = "DarkGrid",
98153
+ /**
98154
+ * Represents dark horizontal texture.
98155
+ * @remarks
98156
+ * [Api set: WordApiDesktop 1.1]
98157
+ */
98158
+ darkHorizontal = "DarkHorizontal",
98159
+ /**
98160
+ * Represents dark diagonal-cross texture.
98161
+ * @remarks
98162
+ * [Api set: WordApiDesktop 1.1]
98163
+ */
98164
+ darkTrellis = "DarkTrellis",
98165
+ /**
98166
+ * Represents dark vertical texture.
98167
+ * @remarks
98168
+ * [Api set: WordApiDesktop 1.1]
98169
+ */
98170
+ darkVertical = "DarkVertical",
98171
+ /**
98172
+ * Represents light diagonal-down texture.
98173
+ * @remarks
98174
+ * [Api set: WordApiDesktop 1.1]
98175
+ */
98176
+ lightDiagonalDown = "LightDiagonalDown",
98177
+ /**
98178
+ * Represents light diagonal-up texture.
98179
+ * @remarks
98180
+ * [Api set: WordApiDesktop 1.1]
98181
+ */
98182
+ lightDiagonalUp = "LightDiagonalUp",
98183
+ /**
98184
+ * Represents light horizontal-cross texture.
98185
+ * @remarks
98186
+ * [Api set: WordApiDesktop 1.1]
98187
+ */
98188
+ lightGrid = "LightGrid",
98189
+ /**
98190
+ * Represents light horizontal texture.
98191
+ * @remarks
98192
+ * [Api set: WordApiDesktop 1.1]
98193
+ */
98194
+ lightHorizontal = "LightHorizontal",
98195
+ /**
98196
+ * Represents light diagonal-cross texture.
98197
+ * @remarks
98198
+ * [Api set: WordApiDesktop 1.1]
98199
+ */
98200
+ lightTrellis = "LightTrellis",
98201
+ /**
98202
+ * Represents light vertical texture.
98203
+ * @remarks
98204
+ * [Api set: WordApiDesktop 1.1]
98205
+ */
98206
+ lightVertical = "LightVertical",
98207
+ /**
98208
+ * Represents that there's no texture.
98209
+ * @remarks
98210
+ * [Api set: WordApiDesktop 1.1]
98211
+ */
98212
+ none = "None",
98213
+ /**
98214
+ * Represents 10 percent texture.
98215
+ * @remarks
98216
+ * [Api set: WordApiDesktop 1.1]
98217
+ */
98218
+ percent10 = "Percent10",
98219
+ /**
98220
+ * Represents 12.5 percent texture.
98221
+ * @remarks
98222
+ * [Api set: WordApiDesktop 1.1]
98223
+ */
98224
+ percent12Pt5 = "Percent12Pt5",
98225
+ /**
98226
+ * Represents 15 percent texture.
98227
+ * @remarks
98228
+ * [Api set: WordApiDesktop 1.1]
98229
+ */
98230
+ percent15 = "Percent15",
98231
+ /**
98232
+ * Represents 20 percent texture.
98233
+ * @remarks
98234
+ * [Api set: WordApiDesktop 1.1]
98235
+ */
98236
+ percent20 = "Percent20",
98237
+ /**
98238
+ * Represents 25 percent texture.
98239
+ * @remarks
98240
+ * [Api set: WordApiDesktop 1.1]
98241
+ */
98242
+ percent25 = "Percent25",
98243
+ /**
98244
+ * Represents 30 percent texture.
98245
+ * @remarks
98246
+ * [Api set: WordApiDesktop 1.1]
98247
+ */
98248
+ percent30 = "Percent30",
98249
+ /**
98250
+ * Represents 35 percent texture.
98251
+ * @remarks
98252
+ * [Api set: WordApiDesktop 1.1]
98253
+ */
98254
+ percent35 = "Percent35",
98255
+ /**
98256
+ * Represents 37.5 percent texture.
98257
+ * @remarks
98258
+ * [Api set: WordApiDesktop 1.1]
98259
+ */
98260
+ percent37Pt5 = "Percent37Pt5",
98261
+ /**
98262
+ * Represents 40 percent texture.
98263
+ * @remarks
98264
+ * [Api set: WordApiDesktop 1.1]
98265
+ */
98266
+ percent40 = "Percent40",
98267
+ /**
98268
+ * Represents 45 percent texture.
98269
+ * @remarks
98270
+ * [Api set: WordApiDesktop 1.1]
98271
+ */
98272
+ percent45 = "Percent45",
98273
+ /**
98274
+ * Represents 5 percent texture.
98275
+ * @remarks
98276
+ * [Api set: WordApiDesktop 1.1]
98277
+ */
98278
+ percent5 = "Percent5",
98279
+ /**
98280
+ * Represents 50 percent texture.
98281
+ * @remarks
98282
+ * [Api set: WordApiDesktop 1.1]
98283
+ */
98284
+ percent50 = "Percent50",
98285
+ /**
98286
+ * Represents 55 percent texture.
98287
+ * @remarks
98288
+ * [Api set: WordApiDesktop 1.1]
98289
+ */
98290
+ percent55 = "Percent55",
98291
+ /**
98292
+ * Represents 60 percent texture.
98293
+ * @remarks
98294
+ * [Api set: WordApiDesktop 1.1]
98295
+ */
98296
+ percent60 = "Percent60",
98297
+ /**
98298
+ * Represents 62.5 percent texture.
98299
+ * @remarks
98300
+ * [Api set: WordApiDesktop 1.1]
98301
+ */
98302
+ percent62Pt5 = "Percent62Pt5",
98303
+ /**
98304
+ * Represents 65 percent texture.
98305
+ * @remarks
98306
+ * [Api set: WordApiDesktop 1.1]
98307
+ */
98308
+ percent65 = "Percent65",
98309
+ /**
98310
+ * Represents 70 percent texture.
98311
+ * @remarks
98312
+ * [Api set: WordApiDesktop 1.1]
98313
+ */
98314
+ percent70 = "Percent70",
98315
+ /**
98316
+ * Represents 75 percent texture.
98317
+ * @remarks
98318
+ * [Api set: WordApiDesktop 1.1]
98319
+ */
98320
+ percent75 = "Percent75",
98321
+ /**
98322
+ * Represents 80 percent texture.
98323
+ * @remarks
98324
+ * [Api set: WordApiDesktop 1.1]
98325
+ */
98326
+ percent80 = "Percent80",
98327
+ /**
98328
+ * Represents 85 percent texture.
98329
+ * @remarks
98330
+ * [Api set: WordApiDesktop 1.1]
98331
+ */
98332
+ percent85 = "Percent85",
98333
+ /**
98334
+ * Represents 87.5 percent texture.
98335
+ * @remarks
98336
+ * [Api set: WordApiDesktop 1.1]
98337
+ */
98338
+ percent87Pt5 = "Percent87Pt5",
98339
+ /**
98340
+ * Represents 90 percent texture.
98341
+ * @remarks
98342
+ * [Api set: WordApiDesktop 1.1]
98343
+ */
98344
+ percent90 = "Percent90",
98345
+ /**
98346
+ * Represents 95 percent texture.
98347
+ * @remarks
98348
+ * [Api set: WordApiDesktop 1.1]
98349
+ */
98350
+ percent95 = "Percent95",
98351
+ /**
98352
+ * Represents solid texture.
98353
+ * @remarks
98354
+ * [Api set: WordApiDesktop 1.1]
98355
+ */
98356
+ solid = "Solid",
98357
+ }
98358
+ /**
98359
+ * Specifies the target document for displaying document comparison differences.
98360
+ *
98361
+ * @remarks
98362
+ * [Api set: WordApiDesktop 1.1]
98363
+ */
98364
+ enum CompareTarget {
98365
+ /**
98366
+ * Places comparison differences in the current document.
98367
+ * @remarks
98368
+ * [Api set: WordApiDesktop 1.1]
98369
+ */
98370
+ compareTargetCurrent = "CompareTargetCurrent",
98371
+ /**
98372
+ * Places comparison differences in the target document.
98373
+ * @remarks
98374
+ * [Api set: WordApiDesktop 1.1]
98375
+ */
98376
+ compareTargetSelected = "CompareTargetSelected",
98377
+ /**
98378
+ * Places comparison differences in a new document.
98379
+ * @remarks
98380
+ * [Api set: WordApiDesktop 1.1]
98381
+ */
98382
+ compareTargetNew = "CompareTargetNew",
98383
+ }
96981
98384
  enum ErrorCodes {
96982
98385
  accessDenied = "AccessDenied",
96983
98386
  generalException = "GeneralException",
@@ -97030,6 +98433,83 @@ declare namespace Word {
97030
98433
  */
97031
98434
  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";
97032
98435
  }
98436
+ /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */
98437
+ interface BorderUpdateData {
98438
+ /**
98439
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
98440
+ *
98441
+ * @remarks
98442
+ * [Api set: WordApiDesktop 1.1]
98443
+ */
98444
+ color?: string;
98445
+ /**
98446
+ * Specifies the border type for the border.
98447
+ *
98448
+ * @remarks
98449
+ * [Api set: WordApiDesktop 1.1]
98450
+ */
98451
+ 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";
98452
+ /**
98453
+ * Specifies whether the border is visible.
98454
+ *
98455
+ * @remarks
98456
+ * [Api set: WordApiDesktop 1.1]
98457
+ */
98458
+ visible?: boolean;
98459
+ /**
98460
+ * Specifies the width for the border.
98461
+ *
98462
+ * @remarks
98463
+ * [Api set: WordApiDesktop 1.1]
98464
+ */
98465
+ width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
98466
+ }
98467
+ /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */
98468
+ interface BorderCollectionUpdateData {
98469
+ /**
98470
+ * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
98471
+ *
98472
+ * @remarks
98473
+ * [Api set: WordApiDesktop 1.1]
98474
+ */
98475
+ insideBorderColor?: string;
98476
+ /**
98477
+ * Specifies the border type of the inside borders.
98478
+ *
98479
+ * @remarks
98480
+ * [Api set: WordApiDesktop 1.1]
98481
+ */
98482
+ 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";
98483
+ /**
98484
+ * Specifies the width of the inside borders.
98485
+ *
98486
+ * @remarks
98487
+ * [Api set: WordApiDesktop 1.1]
98488
+ */
98489
+ insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
98490
+ /**
98491
+ * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
98492
+ *
98493
+ * @remarks
98494
+ * [Api set: WordApiDesktop 1.1]
98495
+ */
98496
+ outsideBorderColor?: string;
98497
+ /**
98498
+ * Specifies the border type of the outside borders.
98499
+ *
98500
+ * @remarks
98501
+ * [Api set: WordApiDesktop 1.1]
98502
+ */
98503
+ 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";
98504
+ /**
98505
+ * Specifies the width of the outside borders.
98506
+ *
98507
+ * @remarks
98508
+ * [Api set: WordApiDesktop 1.1]
98509
+ */
98510
+ outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
98511
+ items?: Word.Interfaces.BorderData[];
98512
+ }
97033
98513
  /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */
97034
98514
  interface CheckboxContentControlUpdateData {
97035
98515
  /**
@@ -97388,6 +98868,13 @@ declare namespace Word {
97388
98868
  * [Api set: WordApi 1.5]
97389
98869
  */
97390
98870
  locked?: boolean;
98871
+ /**
98872
+ * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
98873
+ *
98874
+ * @remarks
98875
+ * [Api set: WordApiDesktop 1.1]
98876
+ */
98877
+ showCodes?: boolean;
97391
98878
  }
97392
98879
  /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */
97393
98880
  interface FieldCollectionUpdateData {
@@ -97536,6 +99023,100 @@ declare namespace Word {
97536
99023
  */
97537
99024
  level?: number;
97538
99025
  }
99026
+ /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */
99027
+ interface ListLevelUpdateData {
99028
+ /**
99029
+ * Gets a Font object that represents the character formatting of the specified object.
99030
+ *
99031
+ * @remarks
99032
+ * [Api set: WordApiDesktop 1.1]
99033
+ */
99034
+ font?: Word.Interfaces.FontUpdateData;
99035
+ /**
99036
+ * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
99037
+ *
99038
+ * @remarks
99039
+ * [Api set: WordApiDesktop 1.1]
99040
+ */
99041
+ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
99042
+ /**
99043
+ * Specifies the name of the style that's linked to the specified list level object.
99044
+ *
99045
+ * @remarks
99046
+ * [Api set: WordApiDesktop 1.1]
99047
+ */
99048
+ linkedStyle?: string;
99049
+ /**
99050
+ * Specifies the number format for the specified list level.
99051
+ *
99052
+ * @remarks
99053
+ * [Api set: WordApiDesktop 1.1]
99054
+ */
99055
+ numberFormat?: string;
99056
+ /**
99057
+ * Specifies the position (in points) of the number or bullet for the specified list level object.
99058
+ *
99059
+ * @remarks
99060
+ * [Api set: WordApiDesktop 1.1]
99061
+ */
99062
+ numberPosition?: number;
99063
+ /**
99064
+ * Specifies the number style for the list level object.
99065
+ *
99066
+ * @remarks
99067
+ * [Api set: WordApiDesktop 1.1]
99068
+ */
99069
+ numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ";
99070
+ /**
99071
+ * Specifies the list level that must appear before the specified list level restarts numbering at 1.
99072
+ *
99073
+ * @remarks
99074
+ * [Api set: WordApiDesktop 1.1]
99075
+ */
99076
+ resetOnHigher?: number;
99077
+ /**
99078
+ * Specifies the starting number for the specified list level object.
99079
+ *
99080
+ * @remarks
99081
+ * [Api set: WordApiDesktop 1.1]
99082
+ */
99083
+ startAt?: number;
99084
+ /**
99085
+ * Specifies the tab position for the specified list level object.
99086
+ *
99087
+ * @remarks
99088
+ * [Api set: WordApiDesktop 1.1]
99089
+ */
99090
+ tabPosition?: number;
99091
+ /**
99092
+ * Specifies the position (in points) for the second line of wrapping text for the specified list level object.
99093
+ *
99094
+ * @remarks
99095
+ * [Api set: WordApiDesktop 1.1]
99096
+ */
99097
+ textPosition?: number;
99098
+ /**
99099
+ * Specifies the character inserted after the number for the specified list level.
99100
+ *
99101
+ * @remarks
99102
+ * [Api set: WordApiDesktop 1.1]
99103
+ */
99104
+ trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone";
99105
+ }
99106
+ /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */
99107
+ interface ListLevelCollectionUpdateData {
99108
+ items?: Word.Interfaces.ListLevelData[];
99109
+ }
99110
+ /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */
99111
+ interface ListTemplateUpdateData {
99112
+ /**
99113
+ * Specifies whether the specified ListTemplate object is outline numbered.
99114
+ *
99115
+ * @remarks
99116
+ * [Api set: WordApiDesktop 1.1]
99117
+ */
99118
+ outlineNumbered?: boolean;
99119
+ }
97539
99120
  /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */
97540
99121
  interface NoteItemUpdateData {
97541
99122
  /**
@@ -97891,6 +99472,13 @@ declare namespace Word {
97891
99472
  }
97892
99473
  /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */
97893
99474
  interface StyleUpdateData {
99475
+ /**
99476
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
99477
+ *
99478
+ * @remarks
99479
+ * [Api set: WordApiDesktop 1.1]
99480
+ */
99481
+ borders?: Word.Interfaces.BorderCollectionUpdateData;
97894
99482
  /**
97895
99483
  * Gets a font object that represents the character formatting of the specified style.
97896
99484
  *
@@ -97898,6 +99486,13 @@ declare namespace Word {
97898
99486
  * [Api set: WordApi 1.5]
97899
99487
  */
97900
99488
  font?: Word.Interfaces.FontUpdateData;
99489
+ /**
99490
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
99491
+ *
99492
+ * @remarks
99493
+ * [Api set: WordApiDesktop 1.1]
99494
+ */
99495
+ listTemplate?: Word.Interfaces.ListTemplateUpdateData;
97901
99496
  /**
97902
99497
  * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
97903
99498
  *
@@ -97975,15 +99570,29 @@ declare namespace Word {
97975
99570
  * [Api set: WordApi 1.6]
97976
99571
  */
97977
99572
  backgroundPatternColor?: string;
99573
+ /**
99574
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
99575
+ *
99576
+ * @remarks
99577
+ * [Api set: WordApiDesktop 1.1]
99578
+ */
99579
+ foregroundPatternColor?: string;
99580
+ /**
99581
+ * 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}.
99582
+ *
99583
+ * @remarks
99584
+ * [Api set: WordApiDesktop 1.1]
99585
+ */
99586
+ texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
97978
99587
  }
97979
99588
  /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */
97980
99589
  interface TableUpdateData {
97981
99590
  /**
97982
- * Gets the font. Use this to get and set font name, size, color, and other properties.
97983
- *
97984
- * @remarks
97985
- * [Api set: WordApi 1.3]
97986
- */
99591
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
99592
+ *
99593
+ * @remarks
99594
+ * [Api set: WordApi 1.3]
99595
+ */
97987
99596
  font?: Word.Interfaces.FontUpdateData;
97988
99597
  /**
97989
99598
  * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
@@ -98086,6 +99695,20 @@ declare namespace Word {
98086
99695
  }
98087
99696
  /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */
98088
99697
  interface TableStyleUpdateData {
99698
+ /**
99699
+ * Specifies the table's alignment against the page margin.
99700
+ *
99701
+ * @remarks
99702
+ * [Api set: WordApiDesktop 1.1]
99703
+ */
99704
+ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
99705
+ /**
99706
+ * Specifies whether lines in tables formatted with a specified style break across pages.
99707
+ *
99708
+ * @remarks
99709
+ * [Api set: WordApiDesktop 1.1]
99710
+ */
99711
+ allowBreakAcrossPage?: boolean;
98089
99712
  /**
98090
99713
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
98091
99714
  *
@@ -98286,55 +99909,55 @@ declare namespace Word {
98286
99909
  /** An interface describing the data returned by calling `body.toJSON()`. */
98287
99910
  interface BodyData {
98288
99911
  /**
98289
- * Gets the collection of rich text content control objects in the body.
98290
- *
98291
- * @remarks
98292
- * [Api set: WordApi 1.1]
98293
- */
99912
+ * Gets the collection of rich text content control objects in the body.
99913
+ *
99914
+ * @remarks
99915
+ * [Api set: WordApi 1.1]
99916
+ */
98294
99917
  contentControls?: Word.Interfaces.ContentControlData[];
98295
99918
  /**
98296
- * Gets the collection of field objects in the body.
98297
- *
98298
- * @remarks
98299
- * [Api set: WordApi 1.4]
98300
- */
99919
+ * Gets the collection of field objects in the body.
99920
+ *
99921
+ * @remarks
99922
+ * [Api set: WordApi 1.4]
99923
+ */
98301
99924
  fields?: Word.Interfaces.FieldData[];
98302
99925
  /**
98303
- * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
98304
- *
98305
- * @remarks
98306
- * [Api set: WordApi 1.1]
98307
- */
99926
+ * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
99927
+ *
99928
+ * @remarks
99929
+ * [Api set: WordApi 1.1]
99930
+ */
98308
99931
  font?: Word.Interfaces.FontData;
98309
99932
  /**
98310
- * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
98311
- *
98312
- * @remarks
98313
- * [Api set: WordApi 1.1]
98314
- */
99933
+ * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
99934
+ *
99935
+ * @remarks
99936
+ * [Api set: WordApi 1.1]
99937
+ */
98315
99938
  inlinePictures?: Word.Interfaces.InlinePictureData[];
98316
99939
  /**
98317
- * Gets the collection of list objects in the body.
98318
- *
98319
- * @remarks
98320
- * [Api set: WordApi 1.3]
98321
- */
99940
+ * Gets the collection of list objects in the body.
99941
+ *
99942
+ * @remarks
99943
+ * [Api set: WordApi 1.3]
99944
+ */
98322
99945
  lists?: Word.Interfaces.ListData[];
98323
99946
  /**
98324
- * Gets the collection of paragraph objects in the body.
98325
- *
98326
- * @remarks
98327
- * [Api set: WordApi 1.1]
98328
- *
98329
- * 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.
98330
- */
99947
+ * Gets the collection of paragraph objects in the body.
99948
+ *
99949
+ * @remarks
99950
+ * [Api set: WordApi 1.1]
99951
+ *
99952
+ * 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.
99953
+ */
98331
99954
  paragraphs?: Word.Interfaces.ParagraphData[];
98332
99955
  /**
98333
- * Gets the collection of table objects in the body.
98334
- *
98335
- * @remarks
98336
- * [Api set: WordApi 1.3]
98337
- */
99956
+ * Gets the collection of table objects in the body.
99957
+ *
99958
+ * @remarks
99959
+ * [Api set: WordApi 1.3]
99960
+ */
98338
99961
  tables?: Word.Interfaces.TableData[];
98339
99962
  /**
98340
99963
  * 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.
@@ -98365,6 +99988,48 @@ declare namespace Word {
98365
99988
  */
98366
99989
  type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem";
98367
99990
  }
99991
+ /** An interface describing the data returned by calling `border.toJSON()`. */
99992
+ interface BorderData {
99993
+ /**
99994
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
99995
+ *
99996
+ * @remarks
99997
+ * [Api set: WordApiDesktop 1.1]
99998
+ */
99999
+ color?: string;
100000
+ /**
100001
+ * Gets the location of the border.
100002
+ *
100003
+ * @remarks
100004
+ * [Api set: WordApiDesktop 1.1]
100005
+ */
100006
+ location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";
100007
+ /**
100008
+ * Specifies the border type for the border.
100009
+ *
100010
+ * @remarks
100011
+ * [Api set: WordApiDesktop 1.1]
100012
+ */
100013
+ 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";
100014
+ /**
100015
+ * Specifies whether the border is visible.
100016
+ *
100017
+ * @remarks
100018
+ * [Api set: WordApiDesktop 1.1]
100019
+ */
100020
+ visible?: boolean;
100021
+ /**
100022
+ * Specifies the width for the border.
100023
+ *
100024
+ * @remarks
100025
+ * [Api set: WordApiDesktop 1.1]
100026
+ */
100027
+ width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
100028
+ }
100029
+ /** An interface describing the data returned by calling `borderCollection.toJSON()`. */
100030
+ interface BorderCollectionData {
100031
+ items?: Word.Interfaces.BorderData[];
100032
+ }
98368
100033
  /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */
98369
100034
  interface CheckboxContentControlData {
98370
100035
  /**
@@ -99043,6 +100708,13 @@ declare namespace Word {
99043
100708
  * [Api set: WordApi 1.5]
99044
100709
  */
99045
100710
  locked?: boolean;
100711
+ /**
100712
+ * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
100713
+ *
100714
+ * @remarks
100715
+ * [Api set: WordApiDesktop 1.1]
100716
+ */
100717
+ showCodes?: boolean;
99046
100718
  /**
99047
100719
  * Gets the field's type.
99048
100720
  *
@@ -99165,6 +100837,13 @@ declare namespace Word {
99165
100837
  * [Api set: WordApi 1.1]
99166
100838
  */
99167
100839
  hyperlink?: string;
100840
+ /**
100841
+ * Gets the format of the inline image.
100842
+ *
100843
+ * @remarks
100844
+ * [Api set: WordApiDesktop 1.1]
100845
+ */
100846
+ imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";
99168
100847
  /**
99169
100848
  * Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
99170
100849
  *
@@ -99243,21 +100922,122 @@ declare namespace Word {
99243
100922
  */
99244
100923
  siblingIndex?: number;
99245
100924
  }
100925
+ /** An interface describing the data returned by calling `listLevel.toJSON()`. */
100926
+ interface ListLevelData {
100927
+ /**
100928
+ * Gets a Font object that represents the character formatting of the specified object.
100929
+ *
100930
+ * @remarks
100931
+ * [Api set: WordApiDesktop 1.1]
100932
+ */
100933
+ font?: Word.Interfaces.FontData;
100934
+ /**
100935
+ * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
100936
+ *
100937
+ * @remarks
100938
+ * [Api set: WordApiDesktop 1.1]
100939
+ */
100940
+ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
100941
+ /**
100942
+ * Specifies the name of the style that's linked to the specified list level object.
100943
+ *
100944
+ * @remarks
100945
+ * [Api set: WordApiDesktop 1.1]
100946
+ */
100947
+ linkedStyle?: string;
100948
+ /**
100949
+ * Specifies the number format for the specified list level.
100950
+ *
100951
+ * @remarks
100952
+ * [Api set: WordApiDesktop 1.1]
100953
+ */
100954
+ numberFormat?: string;
100955
+ /**
100956
+ * Specifies the position (in points) of the number or bullet for the specified list level object.
100957
+ *
100958
+ * @remarks
100959
+ * [Api set: WordApiDesktop 1.1]
100960
+ */
100961
+ numberPosition?: number;
100962
+ /**
100963
+ * Specifies the number style for the list level object.
100964
+ *
100965
+ * @remarks
100966
+ * [Api set: WordApiDesktop 1.1]
100967
+ */
100968
+ numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ";
100969
+ /**
100970
+ * Specifies the list level that must appear before the specified list level restarts numbering at 1.
100971
+ *
100972
+ * @remarks
100973
+ * [Api set: WordApiDesktop 1.1]
100974
+ */
100975
+ resetOnHigher?: number;
100976
+ /**
100977
+ * Specifies the starting number for the specified list level object.
100978
+ *
100979
+ * @remarks
100980
+ * [Api set: WordApiDesktop 1.1]
100981
+ */
100982
+ startAt?: number;
100983
+ /**
100984
+ * Specifies the tab position for the specified list level object.
100985
+ *
100986
+ * @remarks
100987
+ * [Api set: WordApiDesktop 1.1]
100988
+ */
100989
+ tabPosition?: number;
100990
+ /**
100991
+ * Specifies the position (in points) for the second line of wrapping text for the specified list level object.
100992
+ *
100993
+ * @remarks
100994
+ * [Api set: WordApiDesktop 1.1]
100995
+ */
100996
+ textPosition?: number;
100997
+ /**
100998
+ * Specifies the character inserted after the number for the specified list level.
100999
+ *
101000
+ * @remarks
101001
+ * [Api set: WordApiDesktop 1.1]
101002
+ */
101003
+ trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone";
101004
+ }
101005
+ /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */
101006
+ interface ListLevelCollectionData {
101007
+ items?: Word.Interfaces.ListLevelData[];
101008
+ }
101009
+ /** An interface describing the data returned by calling `listTemplate.toJSON()`. */
101010
+ interface ListTemplateData {
101011
+ /**
101012
+ * Gets a ListLevels collection that represents all the levels for the specified ListTemplate.
101013
+ *
101014
+ * @remarks
101015
+ * [Api set: WordApiDesktop 1.1]
101016
+ */
101017
+ listLevels?: Word.Interfaces.ListLevelData[];
101018
+ /**
101019
+ * Specifies whether the specified ListTemplate object is outline numbered.
101020
+ *
101021
+ * @remarks
101022
+ * [Api set: WordApiDesktop 1.1]
101023
+ */
101024
+ outlineNumbered?: boolean;
101025
+ }
99246
101026
  /** An interface describing the data returned by calling `noteItem.toJSON()`. */
99247
101027
  interface NoteItemData {
99248
101028
  /**
99249
- * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
99250
- *
99251
- * @remarks
99252
- * [Api set: WordApi 1.5]
99253
- */
101029
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
101030
+ *
101031
+ * @remarks
101032
+ * [Api set: WordApi 1.5]
101033
+ */
99254
101034
  body?: Word.Interfaces.BodyData;
99255
101035
  /**
99256
- * Represents a footnote or endnote reference in the main document.
99257
- *
99258
- * @remarks
99259
- * [Api set: WordApi 1.5]
99260
- */
101036
+ * Represents a footnote or endnote reference in the main document.
101037
+ *
101038
+ * @remarks
101039
+ * [Api set: WordApi 1.5]
101040
+ */
99261
101041
  reference?: Word.Interfaces.RangeData;
99262
101042
  /**
99263
101043
  * Represents the note item type: footnote or endnote.
@@ -99274,39 +101054,39 @@ declare namespace Word {
99274
101054
  /** An interface describing the data returned by calling `paragraph.toJSON()`. */
99275
101055
  interface ParagraphData {
99276
101056
  /**
99277
- * Gets the collection of fields in the paragraph.
99278
- *
99279
- * @remarks
99280
- * [Api set: WordApi 1.4]
99281
- */
101057
+ * Gets the collection of fields in the paragraph.
101058
+ *
101059
+ * @remarks
101060
+ * [Api set: WordApi 1.4]
101061
+ */
99282
101062
  fields?: Word.Interfaces.FieldData[];
99283
101063
  /**
99284
- * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
99285
- *
99286
- * @remarks
99287
- * [Api set: WordApi 1.1]
99288
- */
101064
+ * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
101065
+ *
101066
+ * @remarks
101067
+ * [Api set: WordApi 1.1]
101068
+ */
99289
101069
  font?: Word.Interfaces.FontData;
99290
101070
  /**
99291
- * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
99292
- *
99293
- * @remarks
99294
- * [Api set: WordApi 1.1]
99295
- */
101071
+ * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
101072
+ *
101073
+ * @remarks
101074
+ * [Api set: WordApi 1.1]
101075
+ */
99296
101076
  inlinePictures?: Word.Interfaces.InlinePictureData[];
99297
101077
  /**
99298
- * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
99299
- *
99300
- * @remarks
99301
- * [Api set: WordApi 1.3]
99302
- */
101078
+ * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
101079
+ *
101080
+ * @remarks
101081
+ * [Api set: WordApi 1.3]
101082
+ */
99303
101083
  listItem?: Word.Interfaces.ListItemData;
99304
101084
  /**
99305
- * 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}.
99306
- *
99307
- * @remarks
99308
- * [Api set: WordApi 1.3]
99309
- */
101085
+ * 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}.
101086
+ *
101087
+ * @remarks
101088
+ * [Api set: WordApi 1.3]
101089
+ */
99310
101090
  listItemOrNullObject?: Word.Interfaces.ListItemData;
99311
101091
  /**
99312
101092
  * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
@@ -99536,25 +101316,25 @@ declare namespace Word {
99536
101316
  /** An interface describing the data returned by calling `range.toJSON()`. */
99537
101317
  interface RangeData {
99538
101318
  /**
99539
- * Gets the collection of field objects in the range.
99540
- *
99541
- * @remarks
99542
- * [Api set: WordApi 1.4]
99543
- */
101319
+ * Gets the collection of field objects in the range.
101320
+ *
101321
+ * @remarks
101322
+ * [Api set: WordApi 1.4]
101323
+ */
99544
101324
  fields?: Word.Interfaces.FieldData[];
99545
101325
  /**
99546
- * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
99547
- *
99548
- * @remarks
99549
- * [Api set: WordApi 1.1]
99550
- */
101326
+ * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
101327
+ *
101328
+ * @remarks
101329
+ * [Api set: WordApi 1.1]
101330
+ */
99551
101331
  font?: Word.Interfaces.FontData;
99552
101332
  /**
99553
- * Gets the collection of inline picture objects in the range.
99554
- *
99555
- * @remarks
99556
- * [Api set: WordApi 1.2]
99557
- */
101333
+ * Gets the collection of inline picture objects in the range.
101334
+ *
101335
+ * @remarks
101336
+ * [Api set: WordApi 1.2]
101337
+ */
99558
101338
  inlinePictures?: Word.Interfaces.InlinePictureData[];
99559
101339
  /**
99560
101340
  * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.
@@ -99651,11 +101431,11 @@ declare namespace Word {
99651
101431
  /** An interface describing the data returned by calling `section.toJSON()`. */
99652
101432
  interface SectionData {
99653
101433
  /**
99654
- * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
99655
- *
99656
- * @remarks
99657
- * [Api set: WordApi 1.1]
99658
- */
101434
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
101435
+ *
101436
+ * @remarks
101437
+ * [Api set: WordApi 1.1]
101438
+ */
99659
101439
  body?: Word.Interfaces.BodyData;
99660
101440
  }
99661
101441
  /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */
@@ -99690,32 +101470,46 @@ declare namespace Word {
99690
101470
  /** An interface describing the data returned by calling `style.toJSON()`. */
99691
101471
  interface StyleData {
99692
101472
  /**
99693
- * Gets a font object that represents the character formatting of the specified style.
99694
- *
99695
- * @remarks
99696
- * [Api set: WordApi 1.5]
99697
- */
101473
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
101474
+ *
101475
+ * @remarks
101476
+ * [Api set: WordApiDesktop 1.1]
101477
+ */
101478
+ borders?: Word.Interfaces.BorderData[];
101479
+ /**
101480
+ * Gets a font object that represents the character formatting of the specified style.
101481
+ *
101482
+ * @remarks
101483
+ * [Api set: WordApi 1.5]
101484
+ */
99698
101485
  font?: Word.Interfaces.FontData;
99699
101486
  /**
99700
- * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
99701
- *
99702
- * @remarks
99703
- * [Api set: WordApi 1.5]
99704
- */
101487
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
101488
+ *
101489
+ * @remarks
101490
+ * [Api set: WordApiDesktop 1.1]
101491
+ */
101492
+ listTemplate?: Word.Interfaces.ListTemplateData;
101493
+ /**
101494
+ * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
101495
+ *
101496
+ * @remarks
101497
+ * [Api set: WordApi 1.5]
101498
+ */
99705
101499
  paragraphFormat?: Word.Interfaces.ParagraphFormatData;
99706
101500
  /**
99707
- * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
99708
- *
99709
- * @remarks
99710
- * [Api set: WordApi 1.6]
99711
- */
101501
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
101502
+ *
101503
+ * @remarks
101504
+ * [Api set: WordApi 1.6]
101505
+ */
99712
101506
  shading?: Word.Interfaces.ShadingData;
99713
101507
  /**
99714
- * Gets a TableStyle object representing Style properties that can be applied to a table.
99715
- *
99716
- * @remarks
99717
- * [Api set: WordApi 1.6]
99718
- */
101508
+ * Gets a TableStyle object representing Style properties that can be applied to a table.
101509
+ *
101510
+ * @remarks
101511
+ * [Api set: WordApi 1.6]
101512
+ */
99719
101513
  tableStyle?: Word.Interfaces.TableStyleData;
99720
101514
  /**
99721
101515
  * Specifies the name of an existing style to use as the base formatting of another style.
@@ -99808,36 +101602,50 @@ declare namespace Word {
99808
101602
  * [Api set: WordApi 1.6]
99809
101603
  */
99810
101604
  backgroundPatternColor?: string;
101605
+ /**
101606
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
101607
+ *
101608
+ * @remarks
101609
+ * [Api set: WordApiDesktop 1.1]
101610
+ */
101611
+ foregroundPatternColor?: string;
101612
+ /**
101613
+ * 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}.
101614
+ *
101615
+ * @remarks
101616
+ * [Api set: WordApiDesktop 1.1]
101617
+ */
101618
+ texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";
99811
101619
  }
99812
101620
  /** An interface describing the data returned by calling `table.toJSON()`. */
99813
101621
  interface TableData {
99814
101622
  /**
99815
- * Gets the collection of field objects in the table.
99816
- *
99817
- * @remarks
99818
- * [Api set: WordApi 1.4]
99819
- */
101623
+ * Gets the collection of field objects in the table.
101624
+ *
101625
+ * @remarks
101626
+ * [Api set: WordApi 1.4]
101627
+ */
99820
101628
  fields?: Word.Interfaces.FieldData[];
99821
101629
  /**
99822
- * Gets the font. Use this to get and set font name, size, color, and other properties.
99823
- *
99824
- * @remarks
99825
- * [Api set: WordApi 1.3]
99826
- */
101630
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
101631
+ *
101632
+ * @remarks
101633
+ * [Api set: WordApi 1.3]
101634
+ */
99827
101635
  font?: Word.Interfaces.FontData;
99828
101636
  /**
99829
- * Gets all of the table rows.
99830
- *
99831
- * @remarks
99832
- * [Api set: WordApi 1.3]
99833
- */
101637
+ * Gets all of the table rows.
101638
+ *
101639
+ * @remarks
101640
+ * [Api set: WordApi 1.3]
101641
+ */
99834
101642
  rows?: Word.Interfaces.TableRowData[];
99835
101643
  /**
99836
- * Gets the child tables nested one level deeper.
99837
- *
99838
- * @remarks
99839
- * [Api set: WordApi 1.3]
99840
- */
101644
+ * Gets the child tables nested one level deeper.
101645
+ *
101646
+ * @remarks
101647
+ * [Api set: WordApi 1.3]
101648
+ */
99841
101649
  tables?: Word.Interfaces.TableData[];
99842
101650
  /**
99843
101651
  * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
@@ -99961,6 +101769,20 @@ declare namespace Word {
99961
101769
  }
99962
101770
  /** An interface describing the data returned by calling `tableStyle.toJSON()`. */
99963
101771
  interface TableStyleData {
101772
+ /**
101773
+ * Specifies the table's alignment against the page margin.
101774
+ *
101775
+ * @remarks
101776
+ * [Api set: WordApiDesktop 1.1]
101777
+ */
101778
+ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
101779
+ /**
101780
+ * Specifies whether lines in tables formatted with a specified style break across pages.
101781
+ *
101782
+ * @remarks
101783
+ * [Api set: WordApiDesktop 1.1]
101784
+ */
101785
+ allowBreakAcrossPage?: boolean;
99964
101786
  /**
99965
101787
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
99966
101788
  *
@@ -100088,11 +101910,11 @@ declare namespace Word {
100088
101910
  /** An interface describing the data returned by calling `tableCell.toJSON()`. */
100089
101911
  interface TableCellData {
100090
101912
  /**
100091
- * Gets the body object of the cell.
100092
- *
100093
- * @remarks
100094
- * [Api set: WordApi 1.3]
100095
- */
101913
+ * Gets the body object of the cell.
101914
+ *
101915
+ * @remarks
101916
+ * [Api set: WordApi 1.3]
101917
+ */
100096
101918
  body?: Word.Interfaces.BodyData;
100097
101919
  /**
100098
101920
  * Gets the index of the cell in its row.
@@ -100182,28 +102004,28 @@ declare namespace Word {
100182
102004
  /** An interface describing the data returned by calling `trackedChange.toJSON()`. */
100183
102005
  interface TrackedChangeData {
100184
102006
  /**
100185
- * Specifies the author of the tracked change.
102007
+ * Gets the author of the tracked change.
100186
102008
  *
100187
102009
  * @remarks
100188
102010
  * [Api set: WordApi 1.6]
100189
102011
  */
100190
102012
  author?: string;
100191
102013
  /**
100192
- * Specifies the date of the tracked change.
102014
+ * Gets the date of the tracked change.
100193
102015
  *
100194
102016
  * @remarks
100195
102017
  * [Api set: WordApi 1.6]
100196
102018
  */
100197
102019
  date?: Date;
100198
102020
  /**
100199
- * Specifies the text of the tracked change.
102021
+ * Gets the text of the tracked change.
100200
102022
  *
100201
102023
  * @remarks
100202
102024
  * [Api set: WordApi 1.6]
100203
102025
  */
100204
102026
  text?: string;
100205
102027
  /**
100206
- * Specifies the type of the tracked change.
102028
+ * Gets the type of the tracked change.
100207
102029
  *
100208
102030
  * @remarks
100209
102031
  * [Api set: WordApi 1.6]
@@ -100226,11 +102048,11 @@ declare namespace Word {
100226
102048
  */
100227
102049
  $all?: boolean;
100228
102050
  /**
100229
- * Gets the range of text that is annotated.
100230
- *
100231
- * @remarks
100232
- * [Api set: WordApi 1.7]
100233
- */
102051
+ * Gets the range of text that is annotated.
102052
+ *
102053
+ * @remarks
102054
+ * [Api set: WordApi 1.7]
102055
+ */
100234
102056
  range?: Word.Interfaces.RangeLoadOptions;
100235
102057
  /**
100236
102058
  * Gets the critique that was passed when the annotation was inserted.
@@ -100395,6 +102217,100 @@ declare namespace Word {
100395
102217
  */
100396
102218
  type?: boolean;
100397
102219
  }
102220
+ /**
102221
+ * Represents the Border object for text, a paragraph, or a table.
102222
+ *
102223
+ * @remarks
102224
+ * [Api set: WordApiDesktop 1.1]
102225
+ */
102226
+ interface BorderLoadOptions {
102227
+ /**
102228
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
102229
+ */
102230
+ $all?: boolean;
102231
+ /**
102232
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
102233
+ *
102234
+ * @remarks
102235
+ * [Api set: WordApiDesktop 1.1]
102236
+ */
102237
+ color?: boolean;
102238
+ /**
102239
+ * Gets the location of the border.
102240
+ *
102241
+ * @remarks
102242
+ * [Api set: WordApiDesktop 1.1]
102243
+ */
102244
+ location?: boolean;
102245
+ /**
102246
+ * Specifies the border type for the border.
102247
+ *
102248
+ * @remarks
102249
+ * [Api set: WordApiDesktop 1.1]
102250
+ */
102251
+ type?: boolean;
102252
+ /**
102253
+ * Specifies whether the border is visible.
102254
+ *
102255
+ * @remarks
102256
+ * [Api set: WordApiDesktop 1.1]
102257
+ */
102258
+ visible?: boolean;
102259
+ /**
102260
+ * Specifies the width for the border.
102261
+ *
102262
+ * @remarks
102263
+ * [Api set: WordApiDesktop 1.1]
102264
+ */
102265
+ width?: boolean;
102266
+ }
102267
+ /**
102268
+ * Represents the collection of border styles.
102269
+ *
102270
+ * @remarks
102271
+ * [Api set: WordApiDesktop 1.1]
102272
+ */
102273
+ interface BorderCollectionLoadOptions {
102274
+ /**
102275
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
102276
+ */
102277
+ $all?: boolean;
102278
+ /**
102279
+ * For EACH ITEM in the collection: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
102280
+ *
102281
+ * @remarks
102282
+ * [Api set: WordApiDesktop 1.1]
102283
+ */
102284
+ color?: boolean;
102285
+ /**
102286
+ * For EACH ITEM in the collection: Gets the location of the border.
102287
+ *
102288
+ * @remarks
102289
+ * [Api set: WordApiDesktop 1.1]
102290
+ */
102291
+ location?: boolean;
102292
+ /**
102293
+ * For EACH ITEM in the collection: Specifies the border type for the border.
102294
+ *
102295
+ * @remarks
102296
+ * [Api set: WordApiDesktop 1.1]
102297
+ */
102298
+ type?: boolean;
102299
+ /**
102300
+ * For EACH ITEM in the collection: Specifies whether the border is visible.
102301
+ *
102302
+ * @remarks
102303
+ * [Api set: WordApiDesktop 1.1]
102304
+ */
102305
+ visible?: boolean;
102306
+ /**
102307
+ * For EACH ITEM in the collection: Specifies the width for the border.
102308
+ *
102309
+ * @remarks
102310
+ * [Api set: WordApiDesktop 1.1]
102311
+ */
102312
+ width?: boolean;
102313
+ }
100398
102314
  /**
100399
102315
  * The data specific to content controls of type CheckBox.
100400
102316
  *
@@ -100607,18 +102523,18 @@ declare namespace Word {
100607
102523
  */
100608
102524
  $all?: boolean;
100609
102525
  /**
100610
- * Specifies the commentReply's content range.
100611
- *
100612
- * @remarks
100613
- * [Api set: WordApi 1.4]
100614
- */
102526
+ * Specifies the commentReply's content range.
102527
+ *
102528
+ * @remarks
102529
+ * [Api set: WordApi 1.4]
102530
+ */
100615
102531
  contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
100616
102532
  /**
100617
- * Gets the parent comment of this reply.
100618
- *
100619
- * @remarks
100620
- * [Api set: WordApi 1.4]
100621
- */
102533
+ * Gets the parent comment of this reply.
102534
+ *
102535
+ * @remarks
102536
+ * [Api set: WordApi 1.4]
102537
+ */
100622
102538
  parentComment?: Word.Interfaces.CommentLoadOptions;
100623
102539
  /**
100624
102540
  * Gets the email of the comment reply's author.
@@ -100668,18 +102584,18 @@ declare namespace Word {
100668
102584
  */
100669
102585
  $all?: boolean;
100670
102586
  /**
100671
- * For EACH ITEM in the collection: Specifies the commentReply's content range.
100672
- *
100673
- * @remarks
100674
- * [Api set: WordApi 1.4]
100675
- */
102587
+ * For EACH ITEM in the collection: Specifies the commentReply's content range.
102588
+ *
102589
+ * @remarks
102590
+ * [Api set: WordApi 1.4]
102591
+ */
100676
102592
  contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
100677
102593
  /**
100678
- * For EACH ITEM in the collection: Gets the parent comment of this reply.
100679
- *
100680
- * @remarks
100681
- * [Api set: WordApi 1.4]
100682
- */
102594
+ * For EACH ITEM in the collection: Gets the parent comment of this reply.
102595
+ *
102596
+ * @remarks
102597
+ * [Api set: WordApi 1.4]
102598
+ */
100683
102599
  parentComment?: Word.Interfaces.CommentLoadOptions;
100684
102600
  /**
100685
102601
  * For EACH ITEM in the collection: Gets the email of the comment reply's author.
@@ -101518,6 +103434,13 @@ declare namespace Word {
101518
103434
  * [Api set: WordApi 1.5]
101519
103435
  */
101520
103436
  locked?: boolean;
103437
+ /**
103438
+ * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
103439
+ *
103440
+ * @remarks
103441
+ * [Api set: WordApiDesktop 1.1]
103442
+ */
103443
+ showCodes?: boolean;
101521
103444
  /**
101522
103445
  * Gets the field's type.
101523
103446
  *
@@ -101629,6 +103552,13 @@ declare namespace Word {
101629
103552
  * [Api set: WordApi 1.5]
101630
103553
  */
101631
103554
  locked?: boolean;
103555
+ /**
103556
+ * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise.
103557
+ *
103558
+ * @remarks
103559
+ * [Api set: WordApiDesktop 1.1]
103560
+ */
103561
+ showCodes?: boolean;
101632
103562
  /**
101633
103563
  * For EACH ITEM in the collection: Gets the field's type.
101634
103564
  *
@@ -101814,6 +103744,13 @@ declare namespace Word {
101814
103744
  * [Api set: WordApi 1.1]
101815
103745
  */
101816
103746
  hyperlink?: boolean;
103747
+ /**
103748
+ * Gets the format of the inline image.
103749
+ *
103750
+ * @remarks
103751
+ * [Api set: WordApiDesktop 1.1]
103752
+ */
103753
+ imageFormat?: boolean;
101817
103754
  /**
101818
103755
  * Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
101819
103756
  *
@@ -101917,6 +103854,13 @@ declare namespace Word {
101917
103854
  * [Api set: WordApi 1.1]
101918
103855
  */
101919
103856
  hyperlink?: boolean;
103857
+ /**
103858
+ * For EACH ITEM in the collection: Gets the format of the inline image.
103859
+ *
103860
+ * @remarks
103861
+ * [Api set: WordApiDesktop 1.1]
103862
+ */
103863
+ imageFormat?: boolean;
101920
103864
  /**
101921
103865
  * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it.
101922
103866
  *
@@ -102031,6 +103975,203 @@ declare namespace Word {
102031
103975
  */
102032
103976
  siblingIndex?: boolean;
102033
103977
  }
103978
+ /**
103979
+ * Represents a list level.
103980
+ *
103981
+ * @remarks
103982
+ * [Api set: WordApiDesktop 1.1]
103983
+ */
103984
+ interface ListLevelLoadOptions {
103985
+ /**
103986
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
103987
+ */
103988
+ $all?: boolean;
103989
+ /**
103990
+ * Gets a Font object that represents the character formatting of the specified object.
103991
+ *
103992
+ * @remarks
103993
+ * [Api set: WordApiDesktop 1.1]
103994
+ */
103995
+ font?: Word.Interfaces.FontLoadOptions;
103996
+ /**
103997
+ * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
103998
+ *
103999
+ * @remarks
104000
+ * [Api set: WordApiDesktop 1.1]
104001
+ */
104002
+ alignment?: boolean;
104003
+ /**
104004
+ * Specifies the name of the style that's linked to the specified list level object.
104005
+ *
104006
+ * @remarks
104007
+ * [Api set: WordApiDesktop 1.1]
104008
+ */
104009
+ linkedStyle?: boolean;
104010
+ /**
104011
+ * Specifies the number format for the specified list level.
104012
+ *
104013
+ * @remarks
104014
+ * [Api set: WordApiDesktop 1.1]
104015
+ */
104016
+ numberFormat?: boolean;
104017
+ /**
104018
+ * Specifies the position (in points) of the number or bullet for the specified list level object.
104019
+ *
104020
+ * @remarks
104021
+ * [Api set: WordApiDesktop 1.1]
104022
+ */
104023
+ numberPosition?: boolean;
104024
+ /**
104025
+ * Specifies the number style for the list level object.
104026
+ *
104027
+ * @remarks
104028
+ * [Api set: WordApiDesktop 1.1]
104029
+ */
104030
+ numberStyle?: boolean;
104031
+ /**
104032
+ * Specifies the list level that must appear before the specified list level restarts numbering at 1.
104033
+ *
104034
+ * @remarks
104035
+ * [Api set: WordApiDesktop 1.1]
104036
+ */
104037
+ resetOnHigher?: boolean;
104038
+ /**
104039
+ * Specifies the starting number for the specified list level object.
104040
+ *
104041
+ * @remarks
104042
+ * [Api set: WordApiDesktop 1.1]
104043
+ */
104044
+ startAt?: boolean;
104045
+ /**
104046
+ * Specifies the tab position for the specified list level object.
104047
+ *
104048
+ * @remarks
104049
+ * [Api set: WordApiDesktop 1.1]
104050
+ */
104051
+ tabPosition?: boolean;
104052
+ /**
104053
+ * Specifies the position (in points) for the second line of wrapping text for the specified list level object.
104054
+ *
104055
+ * @remarks
104056
+ * [Api set: WordApiDesktop 1.1]
104057
+ */
104058
+ textPosition?: boolean;
104059
+ /**
104060
+ * Specifies the character inserted after the number for the specified list level.
104061
+ *
104062
+ * @remarks
104063
+ * [Api set: WordApiDesktop 1.1]
104064
+ */
104065
+ trailingCharacter?: boolean;
104066
+ }
104067
+ /**
104068
+ * Contains a collection of {@link Word.ListLevel} objects.
104069
+ *
104070
+ * @remarks
104071
+ * [Api set: WordApiDesktop 1.1]
104072
+ */
104073
+ interface ListLevelCollectionLoadOptions {
104074
+ /**
104075
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
104076
+ */
104077
+ $all?: boolean;
104078
+ /**
104079
+ * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object.
104080
+ *
104081
+ * @remarks
104082
+ * [Api set: WordApiDesktop 1.1]
104083
+ */
104084
+ font?: Word.Interfaces.FontLoadOptions;
104085
+ /**
104086
+ * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
104087
+ *
104088
+ * @remarks
104089
+ * [Api set: WordApiDesktop 1.1]
104090
+ */
104091
+ alignment?: boolean;
104092
+ /**
104093
+ * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object.
104094
+ *
104095
+ * @remarks
104096
+ * [Api set: WordApiDesktop 1.1]
104097
+ */
104098
+ linkedStyle?: boolean;
104099
+ /**
104100
+ * For EACH ITEM in the collection: Specifies the number format for the specified list level.
104101
+ *
104102
+ * @remarks
104103
+ * [Api set: WordApiDesktop 1.1]
104104
+ */
104105
+ numberFormat?: boolean;
104106
+ /**
104107
+ * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object.
104108
+ *
104109
+ * @remarks
104110
+ * [Api set: WordApiDesktop 1.1]
104111
+ */
104112
+ numberPosition?: boolean;
104113
+ /**
104114
+ * For EACH ITEM in the collection: Specifies the number style for the list level object.
104115
+ *
104116
+ * @remarks
104117
+ * [Api set: WordApiDesktop 1.1]
104118
+ */
104119
+ numberStyle?: boolean;
104120
+ /**
104121
+ * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1.
104122
+ *
104123
+ * @remarks
104124
+ * [Api set: WordApiDesktop 1.1]
104125
+ */
104126
+ resetOnHigher?: boolean;
104127
+ /**
104128
+ * For EACH ITEM in the collection: Specifies the starting number for the specified list level object.
104129
+ *
104130
+ * @remarks
104131
+ * [Api set: WordApiDesktop 1.1]
104132
+ */
104133
+ startAt?: boolean;
104134
+ /**
104135
+ * For EACH ITEM in the collection: Specifies the tab position for the specified list level object.
104136
+ *
104137
+ * @remarks
104138
+ * [Api set: WordApiDesktop 1.1]
104139
+ */
104140
+ tabPosition?: boolean;
104141
+ /**
104142
+ * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object.
104143
+ *
104144
+ * @remarks
104145
+ * [Api set: WordApiDesktop 1.1]
104146
+ */
104147
+ textPosition?: boolean;
104148
+ /**
104149
+ * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level.
104150
+ *
104151
+ * @remarks
104152
+ * [Api set: WordApiDesktop 1.1]
104153
+ */
104154
+ trailingCharacter?: boolean;
104155
+ }
104156
+ /**
104157
+ * Represents a ListTemplate.
104158
+ *
104159
+ * @remarks
104160
+ * [Api set: WordApiDesktop 1.1]
104161
+ */
104162
+ interface ListTemplateLoadOptions {
104163
+ /**
104164
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
104165
+ */
104166
+ $all?: boolean;
104167
+ /**
104168
+ * Specifies whether the specified ListTemplate object is outline numbered.
104169
+ *
104170
+ * @remarks
104171
+ * [Api set: WordApiDesktop 1.1]
104172
+ */
104173
+ outlineNumbered?: boolean;
104174
+ }
102034
104175
  /**
102035
104176
  * Represents a footnote or endnote.
102036
104177
  *
@@ -102076,18 +104217,18 @@ declare namespace Word {
102076
104217
  */
102077
104218
  $all?: boolean;
102078
104219
  /**
102079
- * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
102080
- *
102081
- * @remarks
102082
- * [Api set: WordApi 1.5]
102083
- */
104220
+ * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
104221
+ *
104222
+ * @remarks
104223
+ * [Api set: WordApi 1.5]
104224
+ */
102084
104225
  body?: Word.Interfaces.BodyLoadOptions;
102085
104226
  /**
102086
- * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
102087
- *
102088
- * @remarks
102089
- * [Api set: WordApi 1.5]
102090
- */
104227
+ * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
104228
+ *
104229
+ * @remarks
104230
+ * [Api set: WordApi 1.5]
104231
+ */
102091
104232
  reference?: Word.Interfaces.RangeLoadOptions;
102092
104233
  /**
102093
104234
  * For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
@@ -102917,11 +105058,11 @@ declare namespace Word {
102917
105058
  */
102918
105059
  $all?: boolean;
102919
105060
  /**
102920
- * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
102921
- *
102922
- * @remarks
102923
- * [Api set: WordApi 1.1]
102924
- */
105061
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
105062
+ *
105063
+ * @remarks
105064
+ * [Api set: WordApi 1.1]
105065
+ */
102925
105066
  body?: Word.Interfaces.BodyLoadOptions;
102926
105067
  }
102927
105068
  /**
@@ -103006,6 +105147,13 @@ declare namespace Word {
103006
105147
  Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
103007
105148
  */
103008
105149
  $all?: boolean;
105150
+ /**
105151
+ * For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style.
105152
+ *
105153
+ * @remarks
105154
+ * [Api set: WordApiDesktop 1.1]
105155
+ */
105156
+ borders?: Word.Interfaces.BorderCollectionLoadOptions;
103009
105157
  /**
103010
105158
  * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.
103011
105159
  *
@@ -103013,6 +105161,13 @@ declare namespace Word {
103013
105161
  * [Api set: WordApi 1.5]
103014
105162
  */
103015
105163
  font?: Word.Interfaces.FontLoadOptions;
105164
+ /**
105165
+ * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object.
105166
+ *
105167
+ * @remarks
105168
+ * [Api set: WordApiDesktop 1.1]
105169
+ */
105170
+ listTemplate?: Word.Interfaces.ListTemplateLoadOptions;
103016
105171
  /**
103017
105172
  * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
103018
105173
  *
@@ -103127,6 +105282,13 @@ declare namespace Word {
103127
105282
  Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
103128
105283
  */
103129
105284
  $all?: boolean;
105285
+ /**
105286
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
105287
+ *
105288
+ * @remarks
105289
+ * [Api set: WordApiDesktop 1.1]
105290
+ */
105291
+ borders?: Word.Interfaces.BorderCollectionLoadOptions;
103130
105292
  /**
103131
105293
  * Gets a font object that represents the character formatting of the specified style.
103132
105294
  *
@@ -103134,6 +105296,13 @@ declare namespace Word {
103134
105296
  * [Api set: WordApi 1.5]
103135
105297
  */
103136
105298
  font?: Word.Interfaces.FontLoadOptions;
105299
+ /**
105300
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
105301
+ *
105302
+ * @remarks
105303
+ * [Api set: WordApiDesktop 1.1]
105304
+ */
105305
+ listTemplate?: Word.Interfaces.ListTemplateLoadOptions;
103137
105306
  /**
103138
105307
  * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
103139
105308
  *
@@ -103255,6 +105424,20 @@ declare namespace Word {
103255
105424
  * [Api set: WordApi 1.6]
103256
105425
  */
103257
105426
  backgroundPatternColor?: boolean;
105427
+ /**
105428
+ * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
105429
+ *
105430
+ * @remarks
105431
+ * [Api set: WordApiDesktop 1.1]
105432
+ */
105433
+ foregroundPatternColor?: boolean;
105434
+ /**
105435
+ * 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}.
105436
+ *
105437
+ * @remarks
105438
+ * [Api set: WordApiDesktop 1.1]
105439
+ */
105440
+ texture?: boolean;
103258
105441
  }
103259
105442
  /**
103260
105443
  * Represents a table in a Word document.
@@ -103454,6 +105637,20 @@ declare namespace Word {
103454
105637
  Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
103455
105638
  */
103456
105639
  $all?: boolean;
105640
+ /**
105641
+ * Specifies the table's alignment against the page margin.
105642
+ *
105643
+ * @remarks
105644
+ * [Api set: WordApiDesktop 1.1]
105645
+ */
105646
+ alignment?: boolean;
105647
+ /**
105648
+ * Specifies whether lines in tables formatted with a specified style break across pages.
105649
+ *
105650
+ * @remarks
105651
+ * [Api set: WordApiDesktop 1.1]
105652
+ */
105653
+ allowBreakAcrossPage?: boolean;
103457
105654
  /**
103458
105655
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
103459
105656
  *
@@ -104064,28 +106261,28 @@ declare namespace Word {
104064
106261
  */
104065
106262
  $all?: boolean;
104066
106263
  /**
104067
- * Specifies the author of the tracked change.
106264
+ * Gets the author of the tracked change.
104068
106265
  *
104069
106266
  * @remarks
104070
106267
  * [Api set: WordApi 1.6]
104071
106268
  */
104072
106269
  author?: boolean;
104073
106270
  /**
104074
- * Specifies the date of the tracked change.
106271
+ * Gets the date of the tracked change.
104075
106272
  *
104076
106273
  * @remarks
104077
106274
  * [Api set: WordApi 1.6]
104078
106275
  */
104079
106276
  date?: boolean;
104080
106277
  /**
104081
- * Specifies the text of the tracked change.
106278
+ * Gets the text of the tracked change.
104082
106279
  *
104083
106280
  * @remarks
104084
106281
  * [Api set: WordApi 1.6]
104085
106282
  */
104086
106283
  text?: boolean;
104087
106284
  /**
104088
- * Specifies the type of the tracked change.
106285
+ * Gets the type of the tracked change.
104089
106286
  *
104090
106287
  * @remarks
104091
106288
  * [Api set: WordApi 1.6]
@@ -104104,28 +106301,28 @@ declare namespace Word {
104104
106301
  */
104105
106302
  $all?: boolean;
104106
106303
  /**
104107
- * For EACH ITEM in the collection: Specifies the author of the tracked change.
106304
+ * For EACH ITEM in the collection: Gets the author of the tracked change.
104108
106305
  *
104109
106306
  * @remarks
104110
106307
  * [Api set: WordApi 1.6]
104111
106308
  */
104112
106309
  author?: boolean;
104113
106310
  /**
104114
- * For EACH ITEM in the collection: Specifies the date of the tracked change.
106311
+ * For EACH ITEM in the collection: Gets the date of the tracked change.
104115
106312
  *
104116
106313
  * @remarks
104117
106314
  * [Api set: WordApi 1.6]
104118
106315
  */
104119
106316
  date?: boolean;
104120
106317
  /**
104121
- * For EACH ITEM in the collection: Specifies the text of the tracked change.
106318
+ * For EACH ITEM in the collection: Gets the text of the tracked change.
104122
106319
  *
104123
106320
  * @remarks
104124
106321
  * [Api set: WordApi 1.6]
104125
106322
  */
104126
106323
  text?: boolean;
104127
106324
  /**
104128
- * For EACH ITEM in the collection: Specifies the type of the tracked change.
106325
+ * For EACH ITEM in the collection: Gets the type of the tracked change.
104129
106326
  *
104130
106327
  * @remarks
104131
106328
  * [Api set: WordApi 1.6]