@types/office-js-preview 1.0.566 → 1.0.568

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.
@@ -241,6 +241,10 @@ declare namespace Office {
241
241
  * Represents the Auth interface.
242
242
  */
243
243
  const auth: Auth;
244
+ /**
245
+ * Represents the context menu object associated with the Office application.
246
+ */
247
+ const contextMenu: ContextMenu;
244
248
  /**
245
249
  * Represents the Device Permission interface.
246
250
  */
@@ -4796,12 +4800,71 @@ declare namespace Office {
4796
4800
  */
4797
4801
  version: string;
4798
4802
  }
4803
+ /**
4804
+ * Provides options to manage the state of the Office context menu.
4805
+ *
4806
+ * To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands}.
4807
+ *
4808
+ * @remarks
4809
+ *
4810
+ * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets | ContextMenuApi 1.1}
4811
+ */
4812
+ interface ContextMenu {
4813
+ /**
4814
+ * Sends a request to Office to update the context menu.
4815
+ *
4816
+ * @remarks
4817
+ *
4818
+ * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets | ContextMenuApi 1.1}
4819
+ *
4820
+ * **Important**: This API is only used to request an update. The actual UI update to the context menu is controlled by the Office application,
4821
+ * so the exact timing of the context menu update (or refresh) can't be determined by the completion of this API.
4822
+ *
4823
+ * @param input - Represents the updates to be made to the context menu controls. Only the changes specified in the `control` parameter are made.
4824
+ * Other context menu controls that aren't specified remain as is in the Office application.
4825
+ */
4826
+ requestUpdate(input: ContextMenuUpdaterData): Promise<void>;
4827
+ }
4828
+ /**
4829
+ * Represents an individual context menu control and its state.
4830
+ *
4831
+ * To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands}.
4832
+ *
4833
+ * @remarks
4834
+ *
4835
+ * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets | ContextMenuApi 1.1}
4836
+ */
4837
+ interface ContextMenuControl {
4838
+ /**
4839
+ * Identifier of the context menu control as specified in the manifest.
4840
+ */
4841
+ id: string;
4842
+ /**
4843
+ * Indicates whether the control is available on the context menu.
4844
+ */
4845
+ enabled?: boolean;
4846
+ }
4847
+ /**
4848
+ * Represents the changes to the context menu.
4849
+ *
4850
+ * To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands}.
4851
+ *
4852
+ * @remarks
4853
+ *
4854
+ * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets | ContextMenuApi 1.1}
4855
+ */
4856
+ interface ContextMenuUpdaterData {
4857
+ /**
4858
+ * Collection of context menu controls whose state is set using `Office.contextMenu.requestUpdate`.
4859
+ */
4860
+ controls: ContextMenuControl[];
4861
+ }
4799
4862
  /**
4800
4863
  * Represents an individual control or command and the state it should have.
4801
4864
  *
4802
4865
  * @remarks
4803
4866
  *
4804
- * For code samples showing how to use a `Control` object and its properties, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Enable and Disable Add-in Commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
4867
+ * For code samples showing how to use a `Control` object and its properties, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
4805
4868
  *
4806
4869
  * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
4807
4870
  */
@@ -7241,7 +7304,7 @@ declare namespace Office {
7241
7304
  *
7242
7305
  * Note that this API is only to request an update. The actual UI update to the ribbon is controlled by the Office application and hence the exact timing of the ribbon update (or refresh) cannot be determined by the completion of this API.
7243
7306
  *
7244
- * For code examples, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Enable and Disable Add-in Commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
7307
+ * For code examples, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
7245
7308
  *
7246
7309
  * @param input - Represents the updates to be made to the ribbon. Note that only the changes specified in the input parameter are made.
7247
7310
  */
@@ -7788,7 +7851,7 @@ declare namespace Office {
7788
7851
  size: number;
7789
7852
  }
7790
7853
  /**
7791
- * Represents an individual tab and the state it should have. For code examples, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Enable and Disable Add-in Commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
7854
+ * Represents an individual tab and the state it should have. For code examples, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
7792
7855
  *
7793
7856
  * @remarks
7794
7857
  *
@@ -94471,9 +94534,9 @@ declare namespace Word {
94471
94534
  */
94472
94535
  untrack(): Word.CritiqueAnnotation;
94473
94536
  /**
94474
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94475
- * Whereas the original `Word.CritiqueAnnotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) that contains shallow copies of any loaded child properties from the original object.
94476
- */
94537
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94538
+ * Whereas the original `Word.CritiqueAnnotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) that contains shallow copies of any loaded child properties from the original object.
94539
+ */
94477
94540
  toJSON(): Word.Interfaces.CritiqueAnnotationData;
94478
94541
  }
94479
94542
  /**
@@ -94584,9 +94647,9 @@ declare namespace Word {
94584
94647
  */
94585
94648
  untrack(): Word.Annotation;
94586
94649
  /**
94587
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94588
- * Whereas the original `Word.Annotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) that contains shallow copies of any loaded child properties from the original object.
94589
- */
94650
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94651
+ * Whereas the original `Word.Annotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) that contains shallow copies of any loaded child properties from the original object.
94652
+ */
94590
94653
  toJSON(): Word.Interfaces.AnnotationData;
94591
94654
  }
94592
94655
  /**
@@ -94732,9 +94795,9 @@ declare namespace Word {
94732
94795
  */
94733
94796
  untrack(): Word.AnnotationCollection;
94734
94797
  /**
94735
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94736
- * 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.
94737
- */
94798
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94799
+ * 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.
94800
+ */
94738
94801
  toJSON(): Word.Interfaces.AnnotationCollectionData;
94739
94802
  }
94740
94803
  /**
@@ -94785,9 +94848,9 @@ declare namespace Word {
94785
94848
  */
94786
94849
  static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;
94787
94850
  /**
94788
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94789
- * Whereas the original `Word.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
94790
- */
94851
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94852
+ * Whereas the original `Word.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
94853
+ */
94791
94854
  toJSON(): {
94792
94855
  [key: string]: string;
94793
94856
  };
@@ -95054,7 +95117,7 @@ declare namespace Word {
95054
95117
  * @remarks
95055
95118
  * [Api set: WordApi 1.1]
95056
95119
  *
95057
- * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
95120
+ * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
95058
95121
  *
95059
95122
  * @param base64File Required. The Base64-encoded content of a .docx file.
95060
95123
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
@@ -95238,9 +95301,9 @@ declare namespace Word {
95238
95301
  */
95239
95302
  untrack(): Word.Body;
95240
95303
  /**
95241
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95242
- * Whereas the original `Word.Body` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BodyData`) that contains shallow copies of any loaded child properties from the original object.
95243
- */
95304
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95305
+ * Whereas the original `Word.Body` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BodyData`) that contains shallow copies of any loaded child properties from the original object.
95306
+ */
95244
95307
  toJSON(): Word.Interfaces.BodyData;
95245
95308
  }
95246
95309
  /**
@@ -95325,9 +95388,9 @@ declare namespace Word {
95325
95388
  */
95326
95389
  untrack(): Word.Border;
95327
95390
  /**
95328
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95329
- * 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.
95330
- */
95391
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95392
+ * 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.
95393
+ */
95331
95394
  toJSON(): Word.Interfaces.BorderData;
95332
95395
  }
95333
95396
  /**
@@ -95440,9 +95503,9 @@ declare namespace Word {
95440
95503
  */
95441
95504
  untrack(): Word.BorderCollection;
95442
95505
  /**
95443
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95444
- * 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.
95445
- */
95506
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95507
+ * 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.
95508
+ */
95446
95509
  toJSON(): Word.Interfaces.BorderCollectionData;
95447
95510
  }
95448
95511
  /**
@@ -95499,9 +95562,9 @@ declare namespace Word {
95499
95562
  */
95500
95563
  untrack(): Word.CheckboxContentControl;
95501
95564
  /**
95502
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95503
- * Whereas the original `Word.CheckboxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CheckboxContentControlData`) that contains shallow copies of any loaded child properties from the original object.
95504
- */
95565
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95566
+ * Whereas the original `Word.CheckboxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CheckboxContentControlData`) that contains shallow copies of any loaded child properties from the original object.
95567
+ */
95505
95568
  toJSON(): Word.Interfaces.CheckboxContentControlData;
95506
95569
  }
95507
95570
  /**
@@ -95630,9 +95693,9 @@ declare namespace Word {
95630
95693
  */
95631
95694
  untrack(): Word.Comment;
95632
95695
  /**
95633
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95634
- * Whereas the original `Word.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object.
95635
- */
95696
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95697
+ * Whereas the original `Word.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object.
95698
+ */
95636
95699
  toJSON(): Word.Interfaces.CommentData;
95637
95700
  }
95638
95701
  /**
@@ -95687,9 +95750,9 @@ declare namespace Word {
95687
95750
  */
95688
95751
  untrack(): Word.CommentCollection;
95689
95752
  /**
95690
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95691
- * 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.
95692
- */
95753
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95754
+ * 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.
95755
+ */
95693
95756
  toJSON(): Word.Interfaces.CommentCollectionData;
95694
95757
  }
95695
95758
  /**
@@ -95796,9 +95859,9 @@ declare namespace Word {
95796
95859
  */
95797
95860
  untrack(): Word.CommentContentRange;
95798
95861
  /**
95799
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95800
- * Whereas the original `Word.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object.
95801
- */
95862
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95863
+ * Whereas the original `Word.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object.
95864
+ */
95802
95865
  toJSON(): Word.Interfaces.CommentContentRangeData;
95803
95866
  }
95804
95867
  /**
@@ -95904,9 +95967,9 @@ declare namespace Word {
95904
95967
  */
95905
95968
  untrack(): Word.CommentReply;
95906
95969
  /**
95907
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95908
- * Whereas the original `Word.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object.
95909
- */
95970
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95971
+ * Whereas the original `Word.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object.
95972
+ */
95910
95973
  toJSON(): Word.Interfaces.CommentReplyData;
95911
95974
  }
95912
95975
  /**
@@ -95961,9 +96024,9 @@ declare namespace Word {
95961
96024
  */
95962
96025
  untrack(): Word.CommentReplyCollection;
95963
96026
  /**
95964
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
95965
- * 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.
95966
- */
96027
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
96028
+ * 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.
96029
+ */
95967
96030
  toJSON(): Word.Interfaces.CommentReplyCollectionData;
95968
96031
  }
95969
96032
  /**
@@ -96326,7 +96389,7 @@ declare namespace Word {
96326
96389
  * @remarks
96327
96390
  * [Api set: WordApi 1.1]
96328
96391
  *
96329
- * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
96392
+ * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
96330
96393
  *
96331
96394
  * @param base64File Required. The Base64-encoded content of a .docx file.
96332
96395
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls.
@@ -96585,9 +96648,9 @@ declare namespace Word {
96585
96648
  */
96586
96649
  untrack(): Word.ContentControl;
96587
96650
  /**
96588
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
96589
- * Whereas the original `Word.ContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlData`) that contains shallow copies of any loaded child properties from the original object.
96590
- */
96651
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
96652
+ * Whereas the original `Word.ContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlData`) that contains shallow copies of any loaded child properties from the original object.
96653
+ */
96591
96654
  toJSON(): Word.Interfaces.ContentControlData;
96592
96655
  }
96593
96656
  /**
@@ -96705,9 +96768,9 @@ declare namespace Word {
96705
96768
  */
96706
96769
  untrack(): Word.ContentControlCollection;
96707
96770
  /**
96708
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
96709
- * 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.
96710
- */
96771
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
96772
+ * 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.
96773
+ */
96711
96774
  toJSON(): Word.Interfaces.ContentControlCollectionData;
96712
96775
  }
96713
96776
  /**
@@ -96949,9 +97012,9 @@ declare namespace Word {
96949
97012
  */
96950
97013
  untrack(): Word.CustomProperty;
96951
97014
  /**
96952
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
96953
- * Whereas the original `Word.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object.
96954
- */
97015
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97016
+ * Whereas the original `Word.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object.
97017
+ */
96955
97018
  toJSON(): Word.Interfaces.CustomPropertyData;
96956
97019
  }
96957
97020
  /**
@@ -97034,9 +97097,9 @@ declare namespace Word {
97034
97097
  */
97035
97098
  untrack(): Word.CustomPropertyCollection;
97036
97099
  /**
97037
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97038
- * 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.
97039
- */
97100
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97101
+ * 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.
97102
+ */
97040
97103
  toJSON(): Word.Interfaces.CustomPropertyCollectionData;
97041
97104
  }
97042
97105
  /**
@@ -97313,9 +97376,9 @@ declare namespace Word {
97313
97376
  */
97314
97377
  untrack(): Word.CustomXmlPart;
97315
97378
  /**
97316
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97317
- * Whereas the original `Word.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object.
97318
- */
97379
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97380
+ * Whereas the original `Word.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object.
97381
+ */
97319
97382
  toJSON(): Word.Interfaces.CustomXmlPartData;
97320
97383
  }
97321
97384
  /**
@@ -97399,9 +97462,9 @@ declare namespace Word {
97399
97462
  */
97400
97463
  untrack(): Word.CustomXmlPartCollection;
97401
97464
  /**
97402
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97403
- * 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.
97404
- */
97465
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97466
+ * 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.
97467
+ */
97405
97468
  toJSON(): Word.Interfaces.CustomXmlPartCollectionData;
97406
97469
  }
97407
97470
  /**
@@ -97481,9 +97544,9 @@ declare namespace Word {
97481
97544
  */
97482
97545
  untrack(): Word.CustomXmlPartScopedCollection;
97483
97546
  /**
97484
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97485
- * 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.
97486
- */
97547
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97548
+ * 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.
97549
+ */
97487
97550
  toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData;
97488
97551
  }
97489
97552
  /**
@@ -97752,7 +97815,7 @@ declare namespace Word {
97752
97815
  * @remarks
97753
97816
  * [Api set: WordApi 1.5]
97754
97817
  *
97755
- * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
97818
+ * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
97756
97819
  *
97757
97820
  * @param base64File Required. The Base64-encoded content of a .docx file.
97758
97821
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
@@ -97909,9 +97972,9 @@ declare namespace Word {
97909
97972
  */
97910
97973
  untrack(): Word.Document;
97911
97974
  /**
97912
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97913
- * Whereas the original `Word.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object.
97914
- */
97975
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
97976
+ * Whereas the original `Word.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object.
97977
+ */
97915
97978
  toJSON(): Word.Interfaces.DocumentData;
97916
97979
  }
97917
97980
  /**
@@ -98054,7 +98117,7 @@ declare namespace Word {
98054
98117
  * @remarks
98055
98118
  * [Api set: WordApiHiddenDocument 1.5]
98056
98119
  *
98057
- * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
98120
+ * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
98058
98121
  *
98059
98122
  * @param base64File Required. The Base64-encoded content of a .docx file.
98060
98123
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
@@ -98122,9 +98185,9 @@ declare namespace Word {
98122
98185
  */
98123
98186
  untrack(): Word.DocumentCreated;
98124
98187
  /**
98125
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98126
- * Whereas the original `Word.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object.
98127
- */
98188
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98189
+ * Whereas the original `Word.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object.
98190
+ */
98128
98191
  toJSON(): Word.Interfaces.DocumentCreatedData;
98129
98192
  }
98130
98193
  /**
@@ -98300,9 +98363,9 @@ declare namespace Word {
98300
98363
  */
98301
98364
  untrack(): Word.DocumentProperties;
98302
98365
  /**
98303
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98304
- * Whereas the original `Word.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object.
98305
- */
98366
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98367
+ * Whereas the original `Word.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object.
98368
+ */
98306
98369
  toJSON(): Word.Interfaces.DocumentPropertiesData;
98307
98370
  }
98308
98371
  /**
@@ -98630,9 +98693,9 @@ declare namespace Word {
98630
98693
  */
98631
98694
  untrack(): Word.Field;
98632
98695
  /**
98633
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98634
- * Whereas the original `Word.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object.
98635
- */
98696
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98697
+ * Whereas the original `Word.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object.
98698
+ */
98636
98699
  toJSON(): Word.Interfaces.FieldData;
98637
98700
  }
98638
98701
  /**
@@ -98702,9 +98765,9 @@ declare namespace Word {
98702
98765
  */
98703
98766
  untrack(): Word.FieldCollection;
98704
98767
  /**
98705
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98706
- * 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.
98707
- */
98768
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98769
+ * 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.
98770
+ */
98708
98771
  toJSON(): Word.Interfaces.FieldCollectionData;
98709
98772
  }
98710
98773
  /**
@@ -98839,9 +98902,9 @@ declare namespace Word {
98839
98902
  */
98840
98903
  untrack(): Word.Font;
98841
98904
  /**
98842
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98843
- * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object.
98844
- */
98905
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
98906
+ * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object.
98907
+ */
98845
98908
  toJSON(): Word.Interfaces.FontData;
98846
98909
  }
98847
98910
  /**
@@ -99019,7 +99082,7 @@ declare namespace Word {
99019
99082
  * @remarks
99020
99083
  * [Api set: WordApi 1.2]
99021
99084
  *
99022
- * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
99085
+ * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
99023
99086
  *
99024
99087
  * @param base64File Required. The Base64-encoded content of a .docx file.
99025
99088
  * @param insertLocation Required. The value must be 'Before' or 'After'.
@@ -99123,9 +99186,9 @@ declare namespace Word {
99123
99186
  */
99124
99187
  untrack(): Word.InlinePicture;
99125
99188
  /**
99126
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99127
- * Whereas the original `Word.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object.
99128
- */
99189
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99190
+ * Whereas the original `Word.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object.
99191
+ */
99129
99192
  toJSON(): Word.Interfaces.InlinePictureData;
99130
99193
  }
99131
99194
  /**
@@ -99180,9 +99243,9 @@ declare namespace Word {
99180
99243
  */
99181
99244
  untrack(): Word.InlinePictureCollection;
99182
99245
  /**
99183
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99184
- * 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.
99185
- */
99246
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99247
+ * 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.
99248
+ */
99186
99249
  toJSON(): Word.Interfaces.InlinePictureCollectionData;
99187
99250
  }
99188
99251
  /**
@@ -99405,9 +99468,9 @@ declare namespace Word {
99405
99468
  */
99406
99469
  untrack(): Word.List;
99407
99470
  /**
99408
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99409
- * Whereas the original `Word.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object.
99410
- */
99471
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99472
+ * Whereas the original `Word.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object.
99473
+ */
99411
99474
  toJSON(): Word.Interfaces.ListData;
99412
99475
  }
99413
99476
  /**
@@ -99489,9 +99552,9 @@ declare namespace Word {
99489
99552
  */
99490
99553
  untrack(): Word.ListCollection;
99491
99554
  /**
99492
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99493
- * 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.
99494
- */
99555
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99556
+ * 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.
99557
+ */
99495
99558
  toJSON(): Word.Interfaces.ListCollectionData;
99496
99559
  }
99497
99560
  /**
@@ -99589,9 +99652,9 @@ declare namespace Word {
99589
99652
  */
99590
99653
  untrack(): Word.ListItem;
99591
99654
  /**
99592
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99593
- * Whereas the original `Word.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object.
99594
- */
99655
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99656
+ * Whereas the original `Word.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object.
99657
+ */
99595
99658
  toJSON(): Word.Interfaces.ListItemData;
99596
99659
  }
99597
99660
  /**
@@ -99718,9 +99781,9 @@ declare namespace Word {
99718
99781
  */
99719
99782
  untrack(): Word.ListLevel;
99720
99783
  /**
99721
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99722
- * 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.
99723
- */
99784
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99785
+ * 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.
99786
+ */
99724
99787
  toJSON(): Word.Interfaces.ListLevelData;
99725
99788
  }
99726
99789
  /**
@@ -99775,9 +99838,9 @@ declare namespace Word {
99775
99838
  */
99776
99839
  untrack(): Word.ListLevelCollection;
99777
99840
  /**
99778
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99779
- * 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.
99780
- */
99841
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99842
+ * 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.
99843
+ */
99781
99844
  toJSON(): Word.Interfaces.ListLevelCollectionData;
99782
99845
  }
99783
99846
  /**
@@ -99841,9 +99904,9 @@ declare namespace Word {
99841
99904
  */
99842
99905
  untrack(): Word.ListTemplate;
99843
99906
  /**
99844
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99845
- * 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.
99846
- */
99907
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99908
+ * 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.
99909
+ */
99847
99910
  toJSON(): Word.Interfaces.ListTemplateData;
99848
99911
  }
99849
99912
  /**
@@ -99935,9 +99998,9 @@ declare namespace Word {
99935
99998
  */
99936
99999
  untrack(): Word.NoteItem;
99937
100000
  /**
99938
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99939
- * Whereas the original `Word.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object.
99940
- */
100001
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
100002
+ * Whereas the original `Word.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object.
100003
+ */
99941
100004
  toJSON(): Word.Interfaces.NoteItemData;
99942
100005
  }
99943
100006
  /**
@@ -99992,9 +100055,9 @@ declare namespace Word {
99992
100055
  */
99993
100056
  untrack(): Word.NoteItemCollection;
99994
100057
  /**
99995
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
99996
- * 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.
99997
- */
100058
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
100059
+ * 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.
100060
+ */
99998
100061
  toJSON(): Word.Interfaces.NoteItemCollectionData;
99999
100062
  }
100000
100063
  /**
@@ -100832,7 +100895,7 @@ declare namespace Word {
100832
100895
  * @remarks
100833
100896
  * [Api set: WordApi 1.1]
100834
100897
  *
100835
- * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
100898
+ * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
100836
100899
  *
100837
100900
  * @param base64File Required. The Base64-encoded content of a .docx file.
100838
100901
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
@@ -101074,9 +101137,9 @@ declare namespace Word {
101074
101137
  */
101075
101138
  untrack(): Word.Paragraph;
101076
101139
  /**
101077
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
101078
- * Whereas the original `Word.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object.
101079
- */
101140
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
101141
+ * Whereas the original `Word.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object.
101142
+ */
101080
101143
  toJSON(): Word.Interfaces.ParagraphData;
101081
101144
  }
101082
101145
  /**
@@ -101145,9 +101208,9 @@ declare namespace Word {
101145
101208
  */
101146
101209
  untrack(): Word.ParagraphCollection;
101147
101210
  /**
101148
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
101149
- * 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.
101150
- */
101211
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
101212
+ * 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.
101213
+ */
101151
101214
  toJSON(): Word.Interfaces.ParagraphCollectionData;
101152
101215
  }
101153
101216
  /**
@@ -101295,9 +101358,9 @@ declare namespace Word {
101295
101358
  */
101296
101359
  untrack(): Word.ParagraphFormat;
101297
101360
  /**
101298
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
101299
- * Whereas the original `Word.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
101300
- */
101361
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
101362
+ * Whereas the original `Word.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
101363
+ */
101301
101364
  toJSON(): Word.Interfaces.ParagraphFormatData;
101302
101365
  }
101303
101366
  /**
@@ -101764,7 +101827,7 @@ declare namespace Word {
101764
101827
  * @remarks
101765
101828
  * [Api set: WordApi 1.1]
101766
101829
  *
101767
- * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
101830
+ * Note: Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario.
101768
101831
  *
101769
101832
  * @param base64File Required. The Base64-encoded content of a .docx file.
101770
101833
  * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'.
@@ -102024,9 +102087,9 @@ declare namespace Word {
102024
102087
  */
102025
102088
  untrack(): Word.Range;
102026
102089
  /**
102027
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102028
- * Whereas the original `Word.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object.
102029
- */
102090
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102091
+ * Whereas the original `Word.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object.
102092
+ */
102030
102093
  toJSON(): Word.Interfaces.RangeData;
102031
102094
  }
102032
102095
  /**
@@ -102081,9 +102144,9 @@ declare namespace Word {
102081
102144
  */
102082
102145
  untrack(): Word.RangeCollection;
102083
102146
  /**
102084
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102085
- * 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.
102086
- */
102147
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102148
+ * 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.
102149
+ */
102087
102150
  toJSON(): Word.Interfaces.RangeCollectionData;
102088
102151
  }
102089
102152
  /**
@@ -102279,9 +102342,9 @@ declare namespace Word {
102279
102342
  */
102280
102343
  static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions;
102281
102344
  /**
102282
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102283
- * Whereas the original `Word.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object.
102284
- */
102345
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102346
+ * Whereas the original `Word.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object.
102347
+ */
102285
102348
  toJSON(): Word.Interfaces.SearchOptionsData;
102286
102349
  }
102287
102350
  /**
@@ -102468,9 +102531,9 @@ declare namespace Word {
102468
102531
  */
102469
102532
  untrack(): Word.Section;
102470
102533
  /**
102471
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102472
- * Whereas the original `Word.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object.
102473
- */
102534
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102535
+ * Whereas the original `Word.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object.
102536
+ */
102474
102537
  toJSON(): Word.Interfaces.SectionData;
102475
102538
  }
102476
102539
  /**
@@ -102525,9 +102588,9 @@ declare namespace Word {
102525
102588
  */
102526
102589
  untrack(): Word.SectionCollection;
102527
102590
  /**
102528
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102529
- * 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.
102530
- */
102591
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102592
+ * 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.
102593
+ */
102531
102594
  toJSON(): Word.Interfaces.SectionCollectionData;
102532
102595
  }
102533
102596
  /**
@@ -102598,9 +102661,9 @@ declare namespace Word {
102598
102661
  */
102599
102662
  untrack(): Word.Setting;
102600
102663
  /**
102601
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102602
- * Whereas the original `Word.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object.
102603
- */
102664
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102665
+ * Whereas the original `Word.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object.
102666
+ */
102604
102667
  toJSON(): Word.Interfaces.SettingData;
102605
102668
  }
102606
102669
  /**
@@ -102683,9 +102746,9 @@ declare namespace Word {
102683
102746
  */
102684
102747
  untrack(): Word.SettingCollection;
102685
102748
  /**
102686
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102687
- * 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.
102688
- */
102749
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102750
+ * 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.
102751
+ */
102689
102752
  toJSON(): Word.Interfaces.SettingCollectionData;
102690
102753
  }
102691
102754
  /**
@@ -102760,9 +102823,9 @@ declare namespace Word {
102760
102823
  */
102761
102824
  untrack(): Word.StyleCollection;
102762
102825
  /**
102763
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102764
- * 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.
102765
- */
102826
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102827
+ * 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.
102828
+ */
102766
102829
  toJSON(): Word.Interfaces.StyleCollectionData;
102767
102830
  }
102768
102831
  /**
@@ -102950,9 +103013,9 @@ declare namespace Word {
102950
103013
  */
102951
103014
  untrack(): Word.Style;
102952
103015
  /**
102953
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
102954
- * Whereas the original `Word.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object.
102955
- */
103016
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103017
+ * Whereas the original `Word.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object.
103018
+ */
102956
103019
  toJSON(): Word.Interfaces.StyleData;
102957
103020
  }
102958
103021
  /**
@@ -103023,9 +103086,9 @@ declare namespace Word {
103023
103086
  */
103024
103087
  untrack(): Word.Shading;
103025
103088
  /**
103026
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103027
- * Whereas the original `Word.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object.
103028
- */
103089
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103090
+ * Whereas the original `Word.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object.
103091
+ */
103029
103092
  toJSON(): Word.Interfaces.ShadingData;
103030
103093
  }
103031
103094
  /**
@@ -103559,9 +103622,9 @@ declare namespace Word {
103559
103622
  */
103560
103623
  untrack(): Word.Table;
103561
103624
  /**
103562
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103563
- * Whereas the original `Word.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
103564
- */
103625
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103626
+ * Whereas the original `Word.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
103627
+ */
103565
103628
  toJSON(): Word.Interfaces.TableData;
103566
103629
  }
103567
103630
  /**
@@ -103660,9 +103723,9 @@ declare namespace Word {
103660
103723
  */
103661
103724
  untrack(): Word.TableStyle;
103662
103725
  /**
103663
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103664
- * Whereas the original `Word.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object.
103665
- */
103726
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103727
+ * Whereas the original `Word.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object.
103728
+ */
103666
103729
  toJSON(): Word.Interfaces.TableStyleData;
103667
103730
  }
103668
103731
  /**
@@ -103717,9 +103780,9 @@ declare namespace Word {
103717
103780
  */
103718
103781
  untrack(): Word.TableCollection;
103719
103782
  /**
103720
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103721
- * 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.
103722
- */
103783
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
103784
+ * 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.
103785
+ */
103723
103786
  toJSON(): Word.Interfaces.TableCollectionData;
103724
103787
  }
103725
103788
  /**
@@ -104012,9 +104075,9 @@ declare namespace Word {
104012
104075
  */
104013
104076
  untrack(): Word.TableRow;
104014
104077
  /**
104015
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104016
- * Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
104017
- */
104078
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104079
+ * Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
104080
+ */
104018
104081
  toJSON(): Word.Interfaces.TableRowData;
104019
104082
  }
104020
104083
  /**
@@ -104069,9 +104132,9 @@ declare namespace Word {
104069
104132
  */
104070
104133
  untrack(): Word.TableRowCollection;
104071
104134
  /**
104072
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104073
- * 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.
104074
- */
104135
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104136
+ * 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.
104137
+ */
104075
104138
  toJSON(): Word.Interfaces.TableRowCollectionData;
104076
104139
  }
104077
104140
  /**
@@ -104314,9 +104377,9 @@ declare namespace Word {
104314
104377
  */
104315
104378
  untrack(): Word.TableCell;
104316
104379
  /**
104317
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104318
- * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
104319
- */
104380
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104381
+ * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
104382
+ */
104320
104383
  toJSON(): Word.Interfaces.TableCellData;
104321
104384
  }
104322
104385
  /**
@@ -104371,9 +104434,9 @@ declare namespace Word {
104371
104434
  */
104372
104435
  untrack(): Word.TableCellCollection;
104373
104436
  /**
104374
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104375
- * 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.
104376
- */
104437
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104438
+ * 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.
104439
+ */
104377
104440
  toJSON(): Word.Interfaces.TableCellCollectionData;
104378
104441
  }
104379
104442
  /**
@@ -104444,9 +104507,9 @@ declare namespace Word {
104444
104507
  */
104445
104508
  untrack(): Word.TableBorder;
104446
104509
  /**
104447
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104448
- * Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object.
104449
- */
104510
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104511
+ * Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object.
104512
+ */
104450
104513
  toJSON(): Word.Interfaces.TableBorderData;
104451
104514
  }
104452
104515
  /**
@@ -104551,9 +104614,9 @@ declare namespace Word {
104551
104614
  */
104552
104615
  untrack(): Word.TrackedChange;
104553
104616
  /**
104554
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104555
- * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object.
104556
- */
104617
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104618
+ * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object.
104619
+ */
104557
104620
  toJSON(): Word.Interfaces.TrackedChangeData;
104558
104621
  }
104559
104622
  /**
@@ -104622,9 +104685,9 @@ declare namespace Word {
104622
104685
  */
104623
104686
  untrack(): Word.TrackedChangeCollection;
104624
104687
  /**
104625
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104626
- * 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.
104627
- */
104688
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104689
+ * 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.
104690
+ */
104628
104691
  toJSON(): Word.Interfaces.TrackedChangeCollectionData;
104629
104692
  }
104630
104693
  /**
@@ -104699,6 +104762,13 @@ declare namespace Word {
104699
104762
  * [Api set: WordApiDesktop 1.2]
104700
104763
  */
104701
104764
  allowOverlap: boolean;
104765
+ /**
104766
+ * Specifies a string that represents the alternative text associated with the shape.
104767
+ *
104768
+ * @remarks
104769
+ * [Api set: WordApiDesktop 1.2]
104770
+ */
104771
+ altTextDescription: string;
104702
104772
  /**
104703
104773
  * The geometric shape type of the shape. It will be null if isn't a geometric shape.
104704
104774
  *
@@ -104713,6 +104783,13 @@ declare namespace Word {
104713
104783
  * [Api set: WordApiDesktop 1.2]
104714
104784
  */
104715
104785
  height: number;
104786
+ /**
104787
+ * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
104788
+ *
104789
+ * @remarks
104790
+ * [Api set: WordApiDesktop 1.2]
104791
+ */
104792
+ heightRelative: number;
104716
104793
  /**
104717
104794
  * Gets an integer that represents the shape identifier.
104718
104795
  *
@@ -104734,6 +104811,20 @@ declare namespace Word {
104734
104811
  * [Api set: WordApiDesktop 1.2]
104735
104812
  */
104736
104813
  left: number;
104814
+ /**
104815
+ * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
104816
+ *
104817
+ * @remarks
104818
+ * [Api set: WordApiDesktop 1.2]
104819
+ */
104820
+ leftRelative: number;
104821
+ /**
104822
+ * Specifies if the aspect ratio of this shape is locked.
104823
+ *
104824
+ * @remarks
104825
+ * [Api set: WordApiDesktop 1.2]
104826
+ */
104827
+ lockAspectRatio: boolean;
104737
104828
  /**
104738
104829
  * The name of the shape.
104739
104830
  *
@@ -104748,6 +104839,13 @@ declare namespace Word {
104748
104839
  * [Api set: WordApiDesktop 1.2]
104749
104840
  */
104750
104841
  relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
104842
+ /**
104843
+ * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
104844
+ *
104845
+ * @remarks
104846
+ * [Api set: WordApiDesktop 1.2]
104847
+ */
104848
+ relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
104751
104849
  /**
104752
104850
  * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
104753
104851
  *
@@ -104755,6 +104853,20 @@ declare namespace Word {
104755
104853
  * [Api set: WordApiDesktop 1.2]
104756
104854
  */
104757
104855
  relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
104856
+ /**
104857
+ * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
104858
+ *
104859
+ * @remarks
104860
+ * [Api set: WordApiDesktop 1.2]
104861
+ */
104862
+ relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
104863
+ /**
104864
+ * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape.
104865
+ *
104866
+ * @remarks
104867
+ * [Api set: WordApiDesktop 1.2]
104868
+ */
104869
+ rotation: number;
104758
104870
  /**
104759
104871
  * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
104760
104872
  *
@@ -104762,6 +104874,13 @@ declare namespace Word {
104762
104874
  * [Api set: WordApiDesktop 1.2]
104763
104875
  */
104764
104876
  top: number;
104877
+ /**
104878
+ * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
104879
+ *
104880
+ * @remarks
104881
+ * [Api set: WordApiDesktop 1.2]
104882
+ */
104883
+ topRelative: number;
104765
104884
  /**
104766
104885
  * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
104767
104886
  *
@@ -104769,6 +104888,13 @@ declare namespace Word {
104769
104888
  * [Api set: WordApiDesktop 1.2]
104770
104889
  */
104771
104890
  readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
104891
+ /**
104892
+ * Specifies if the shape is visible. Not applicable to inline shapes.
104893
+ *
104894
+ * @remarks
104895
+ * [Api set: WordApiDesktop 1.2]
104896
+ */
104897
+ visible: boolean;
104772
104898
  /**
104773
104899
  * The width, in points, of the shape.
104774
104900
  *
@@ -104776,6 +104902,13 @@ declare namespace Word {
104776
104902
  * [Api set: WordApiDesktop 1.2]
104777
104903
  */
104778
104904
  width: number;
104905
+ /**
104906
+ * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
104907
+ *
104908
+ * @remarks
104909
+ * [Api set: WordApiDesktop 1.2]
104910
+ */
104911
+ widthRelative: number;
104779
104912
  /**
104780
104913
  * 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.
104781
104914
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
@@ -104809,6 +104942,50 @@ declare namespace Word {
104809
104942
  * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down.
104810
104943
  */
104811
104944
  moveVertically(distance: number): void;
104945
+ /**
104946
+ * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height.
104947
+ *
104948
+ * @remarks
104949
+ * [Api set: WordApiDesktop 1.2]
104950
+ *
104951
+ * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height.
104952
+ * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images.
104953
+ * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position.
104954
+ */
104955
+ scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;
104956
+ /**
104957
+ * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height.
104958
+ *
104959
+ * @remarks
104960
+ * [Api set: WordApiDesktop 1.2]
104961
+ *
104962
+ * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height.
104963
+ * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images.
104964
+ * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position.
104965
+ */
104966
+ scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;
104967
+ /**
104968
+ * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height.
104969
+ *
104970
+ * @remarks
104971
+ * [Api set: WordApiDesktop 1.2]
104972
+ *
104973
+ * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width.
104974
+ * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images.
104975
+ * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position.
104976
+ */
104977
+ scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;
104978
+ /**
104979
+ * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height.
104980
+ *
104981
+ * @remarks
104982
+ * [Api set: WordApiDesktop 1.2]
104983
+ *
104984
+ * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width.
104985
+ * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images.
104986
+ * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position.
104987
+ */
104988
+ scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;
104812
104989
  /**
104813
104990
  * Selects the shape.
104814
104991
  *
@@ -104848,9 +105025,9 @@ declare namespace Word {
104848
105025
  */
104849
105026
  untrack(): Word.Shape;
104850
105027
  /**
104851
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
104852
- * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
104853
- */
105028
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
105029
+ * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
105030
+ */
104854
105031
  toJSON(): Word.Interfaces.ShapeData;
104855
105032
  }
104856
105033
  /**
@@ -105119,9 +105296,9 @@ declare namespace Word {
105119
105296
  */
105120
105297
  untrack(): Word.ShapeCollection;
105121
105298
  /**
105122
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
105123
- * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
105124
- */
105299
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
105300
+ * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
105301
+ */
105125
105302
  toJSON(): Word.Interfaces.ShapeCollectionData;
105126
105303
  }
105127
105304
  /**
@@ -106736,7 +106913,7 @@ declare namespace Word {
106736
106913
  */
106737
106914
  start = "Start",
106738
106915
  /**
106739
- * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it is the point before the closing tag.
106916
+ * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag.
106740
106917
  * @remarks
106741
106918
  * [Api set: WordApi 1.3]
106742
106919
  */
@@ -109573,6 +109750,51 @@ declare namespace Word {
109573
109750
  */
109574
109751
  outsideMargin = "OutsideMargin",
109575
109752
  }
109753
+ /**
109754
+ * Represents what the horizontal or vertical size of a shape is relative to.
109755
+ For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}.
109756
+ *
109757
+ * @remarks
109758
+ * [Api set: WordApiDesktop 1.2]
109759
+ */
109760
+ enum RelativeSize {
109761
+ /**
109762
+ * Relative to margin.
109763
+ * @remarks
109764
+ * [Api set: WordApiDesktop 1.2]
109765
+ */
109766
+ margin = "Margin",
109767
+ /**
109768
+ * Relative to page.
109769
+ * @remarks
109770
+ * [Api set: WordApiDesktop 1.2]
109771
+ */
109772
+ page = "Page",
109773
+ /**
109774
+ * Relative to top margin.
109775
+ * @remarks
109776
+ * [Api set: WordApiDesktop 1.2]
109777
+ */
109778
+ topMargin = "TopMargin",
109779
+ /**
109780
+ * Relative to bottom margin.
109781
+ * @remarks
109782
+ * [Api set: WordApiDesktop 1.2]
109783
+ */
109784
+ bottomMargin = "BottomMargin",
109785
+ /**
109786
+ * Relative to inside margin.
109787
+ * @remarks
109788
+ * [Api set: WordApiDesktop 1.2]
109789
+ */
109790
+ insideMargin = "InsideMargin",
109791
+ /**
109792
+ * Relative to outside margin.
109793
+ * @remarks
109794
+ * [Api set: WordApiDesktop 1.2]
109795
+ */
109796
+ outsideMargin = "OutsideMargin",
109797
+ }
109576
109798
  /**
109577
109799
  * Specifies the shape type for a `GeometricShape` object.
109578
109800
  *
@@ -110889,6 +111111,52 @@ declare namespace Word {
110889
111111
  */
110890
111112
  largest = "Largest",
110891
111113
  }
111114
+ /**
111115
+ * Specifies the scale size type of a shape.
111116
+ *
111117
+ * @remarks
111118
+ * [Api set: WordApiDesktop 1.2]
111119
+ */
111120
+ enum ShapeScaleType {
111121
+ /**
111122
+ * Scale from current size of the shape.
111123
+ * @remarks
111124
+ * [Api set: WordApiDesktop 1.2]
111125
+ */
111126
+ currentSize = "CurrentSize",
111127
+ /**
111128
+ * Scale from original size of the shape. It only works for pictures.
111129
+ * @remarks
111130
+ * [Api set: WordApiDesktop 1.2]
111131
+ */
111132
+ originalSize = "OriginalSize",
111133
+ }
111134
+ /**
111135
+ * Specifies which part of the shape retains its position when the shape is scaled.
111136
+ *
111137
+ * @remarks
111138
+ * [Api set: WordApiDesktop 1.2]
111139
+ */
111140
+ enum ShapeScaleFrom {
111141
+ /**
111142
+ * Scale from the top left corner of the shape.
111143
+ * @remarks
111144
+ * [Api set: WordApiDesktop 1.2]
111145
+ */
111146
+ scaleFromTopLeft = "ScaleFromTopLeft",
111147
+ /**
111148
+ * Scale from the center of the shape.
111149
+ * @remarks
111150
+ * [Api set: WordApiDesktop 1.2]
111151
+ */
111152
+ scaleFromMiddle = "ScaleFromMiddle",
111153
+ /**
111154
+ * Scale from the bottom right corner of the shape.
111155
+ * @remarks
111156
+ * [Api set: WordApiDesktop 1.2]
111157
+ */
111158
+ scaleFromBottomRight = "ScaleFromBottomRight",
111159
+ }
110892
111160
  enum ErrorCodes {
110893
111161
  accessDenied = "AccessDenied",
110894
111162
  generalException = "GeneralException",
@@ -110901,16 +111169,16 @@ declare namespace Word {
110901
111169
  }
110902
111170
  namespace Interfaces {
110903
111171
  /**
110904
- * Provides ways to load properties of only a subset of members of a collection.
110905
- */
111172
+ * Provides ways to load properties of only a subset of members of a collection.
111173
+ */
110906
111174
  interface CollectionLoadOptions {
110907
111175
  /**
110908
- * Specify the number of items in the queried collection to be included in the result.
110909
- */
111176
+ * Specify the number of items in the queried collection to be included in the result.
111177
+ */
110910
111178
  $top?: number;
110911
111179
  /**
110912
- * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items.
110913
- */
111180
+ * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items.
111181
+ */
110914
111182
  $skip?: number;
110915
111183
  }
110916
111184
  /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */
@@ -110920,11 +111188,11 @@ declare namespace Word {
110920
111188
  /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */
110921
111189
  interface BodyUpdateData {
110922
111190
  /**
110923
- * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
110924
- *
110925
- * @remarks
110926
- * [Api set: WordApi 1.1]
110927
- */
111191
+ * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
111192
+ *
111193
+ * @remarks
111194
+ * [Api set: WordApi 1.1]
111195
+ */
110928
111196
  font?: Word.Interfaces.FontUpdateData;
110929
111197
  /**
110930
111198
  * 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.
@@ -111031,11 +111299,11 @@ declare namespace Word {
111031
111299
  /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */
111032
111300
  interface CommentUpdateData {
111033
111301
  /**
111034
- * Specifies the comment's content range.
111035
- *
111036
- * @remarks
111037
- * [Api set: WordApi 1.4]
111038
- */
111302
+ * Specifies the comment's content range.
111303
+ *
111304
+ * @remarks
111305
+ * [Api set: WordApi 1.4]
111306
+ */
111039
111307
  contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
111040
111308
  /**
111041
111309
  * Specifies the comment's content as plain text.
@@ -111097,18 +111365,18 @@ declare namespace Word {
111097
111365
  /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */
111098
111366
  interface CommentReplyUpdateData {
111099
111367
  /**
111100
- * Specifies the commentReply's content range.
111101
- *
111102
- * @remarks
111103
- * [Api set: WordApi 1.4]
111104
- */
111368
+ * Specifies the commentReply's content range.
111369
+ *
111370
+ * @remarks
111371
+ * [Api set: WordApi 1.4]
111372
+ */
111105
111373
  contentRange?: Word.Interfaces.CommentContentRangeUpdateData;
111106
111374
  /**
111107
- * Gets the parent comment of this reply.
111108
- *
111109
- * @remarks
111110
- * [Api set: WordApi 1.4]
111111
- */
111375
+ * Gets the parent comment of this reply.
111376
+ *
111377
+ * @remarks
111378
+ * [Api set: WordApi 1.4]
111379
+ */
111112
111380
  parentComment?: Word.Interfaces.CommentUpdateData;
111113
111381
  /**
111114
111382
  * Specifies the comment reply's content. The string is plain text.
@@ -111125,18 +111393,18 @@ declare namespace Word {
111125
111393
  /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */
111126
111394
  interface ContentControlUpdateData {
111127
111395
  /**
111128
- * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
111129
- *
111130
- * @remarks
111131
- * [Api set: WordApi 1.7]
111132
- */
111396
+ * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
111397
+ *
111398
+ * @remarks
111399
+ * [Api set: WordApi 1.7]
111400
+ */
111133
111401
  checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData;
111134
111402
  /**
111135
- * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
111136
- *
111137
- * @remarks
111138
- * [Api set: WordApi 1.1]
111139
- */
111403
+ * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
111404
+ *
111405
+ * @remarks
111406
+ * [Api set: WordApi 1.1]
111407
+ */
111140
111408
  font?: Word.Interfaces.FontUpdateData;
111141
111409
  /**
111142
111410
  * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
@@ -111266,18 +111534,18 @@ declare namespace Word {
111266
111534
  /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */
111267
111535
  interface DocumentUpdateData {
111268
111536
  /**
111269
- * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
111270
- *
111271
- * @remarks
111272
- * [Api set: WordApi 1.1]
111273
- */
111537
+ * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
111538
+ *
111539
+ * @remarks
111540
+ * [Api set: WordApi 1.1]
111541
+ */
111274
111542
  body?: Word.Interfaces.BodyUpdateData;
111275
111543
  /**
111276
- * Gets the properties of the document.
111277
- *
111278
- * @remarks
111279
- * [Api set: WordApi 1.3]
111280
- */
111544
+ * Gets the properties of the document.
111545
+ *
111546
+ * @remarks
111547
+ * [Api set: WordApi 1.3]
111548
+ */
111281
111549
  properties?: Word.Interfaces.DocumentPropertiesUpdateData;
111282
111550
  /**
111283
111551
  * Specifies the ChangeTracking mode.
@@ -111290,18 +111558,18 @@ declare namespace Word {
111290
111558
  /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */
111291
111559
  interface DocumentCreatedUpdateData {
111292
111560
  /**
111293
- * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
111294
- *
111295
- * @remarks
111296
- * [Api set: WordApiHiddenDocument 1.3]
111297
- */
111561
+ * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
111562
+ *
111563
+ * @remarks
111564
+ * [Api set: WordApiHiddenDocument 1.3]
111565
+ */
111298
111566
  body?: Word.Interfaces.BodyUpdateData;
111299
111567
  /**
111300
- * Gets the properties of the document.
111301
- *
111302
- * @remarks
111303
- * [Api set: WordApiHiddenDocument 1.3]
111304
- */
111568
+ * Gets the properties of the document.
111569
+ *
111570
+ * @remarks
111571
+ * [Api set: WordApiHiddenDocument 1.3]
111572
+ */
111305
111573
  properties?: Word.Interfaces.DocumentPropertiesUpdateData;
111306
111574
  }
111307
111575
  /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */
@@ -111373,11 +111641,11 @@ declare namespace Word {
111373
111641
  /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */
111374
111642
  interface FieldUpdateData {
111375
111643
  /**
111376
- * Gets the field's result data.
111377
- *
111378
- * @remarks
111379
- * [Api set: WordApi 1.4]
111380
- */
111644
+ * Gets the field's result data.
111645
+ *
111646
+ * @remarks
111647
+ * [Api set: WordApi 1.4]
111648
+ */
111381
111649
  result?: Word.Interfaces.RangeUpdateData;
111382
111650
  /**
111383
111651
  * Specifies the field's code instruction.
@@ -111568,11 +111836,11 @@ declare namespace Word {
111568
111836
  /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */
111569
111837
  interface ListLevelUpdateData {
111570
111838
  /**
111571
- * Gets a Font object that represents the character formatting of the specified object.
111572
- *
111573
- * @remarks
111574
- * [Api set: WordApiDesktop 1.1]
111575
- */
111839
+ * Gets a Font object that represents the character formatting of the specified object.
111840
+ *
111841
+ * @remarks
111842
+ * [Api set: WordApiDesktop 1.1]
111843
+ */
111576
111844
  font?: Word.Interfaces.FontUpdateData;
111577
111845
  /**
111578
111846
  * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
@@ -111662,18 +111930,18 @@ declare namespace Word {
111662
111930
  /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */
111663
111931
  interface NoteItemUpdateData {
111664
111932
  /**
111665
- * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
111666
- *
111667
- * @remarks
111668
- * [Api set: WordApi 1.5]
111669
- */
111933
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
111934
+ *
111935
+ * @remarks
111936
+ * [Api set: WordApi 1.5]
111937
+ */
111670
111938
  body?: Word.Interfaces.BodyUpdateData;
111671
111939
  /**
111672
- * Represents a footnote or endnote reference in the main document.
111673
- *
111674
- * @remarks
111675
- * [Api set: WordApi 1.5]
111676
- */
111940
+ * Represents a footnote or endnote reference in the main document.
111941
+ *
111942
+ * @remarks
111943
+ * [Api set: WordApi 1.5]
111944
+ */
111677
111945
  reference?: Word.Interfaces.RangeUpdateData;
111678
111946
  }
111679
111947
  /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */
@@ -111908,11 +112176,11 @@ declare namespace Word {
111908
112176
  /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */
111909
112177
  interface RangeUpdateData {
111910
112178
  /**
111911
- * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
111912
- *
111913
- * @remarks
111914
- * [Api set: WordApi 1.1]
111915
- */
112179
+ * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
112180
+ *
112181
+ * @remarks
112182
+ * [Api set: WordApi 1.1]
112183
+ */
111916
112184
  font?: Word.Interfaces.FontUpdateData;
111917
112185
  /**
111918
112186
  * 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.
@@ -111995,11 +112263,11 @@ declare namespace Word {
111995
112263
  /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */
111996
112264
  interface SectionUpdateData {
111997
112265
  /**
111998
- * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
111999
- *
112000
- * @remarks
112001
- * [Api set: WordApi 1.1]
112002
- */
112266
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
112267
+ *
112268
+ * @remarks
112269
+ * [Api set: WordApi 1.1]
112270
+ */
112003
112271
  body?: Word.Interfaces.BodyUpdateData;
112004
112272
  }
112005
112273
  /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */
@@ -112027,46 +112295,46 @@ declare namespace Word {
112027
112295
  /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */
112028
112296
  interface StyleUpdateData {
112029
112297
  /**
112030
- * Specifies a BorderCollection object that represents all the borders for the specified style.
112031
- *
112032
- * @remarks
112033
- * [Api set: WordApiDesktop 1.1]
112034
- */
112298
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
112299
+ *
112300
+ * @remarks
112301
+ * [Api set: WordApiDesktop 1.1]
112302
+ */
112035
112303
  borders?: Word.Interfaces.BorderCollectionUpdateData;
112036
112304
  /**
112037
- * Gets a font object that represents the character formatting of the specified style.
112038
- *
112039
- * @remarks
112040
- * [Api set: WordApi 1.5]
112041
- */
112305
+ * Gets a font object that represents the character formatting of the specified style.
112306
+ *
112307
+ * @remarks
112308
+ * [Api set: WordApi 1.5]
112309
+ */
112042
112310
  font?: Word.Interfaces.FontUpdateData;
112043
112311
  /**
112044
- * Gets a ListTemplate object that represents the list formatting for the specified Style object.
112045
- *
112046
- * @remarks
112047
- * [Api set: WordApiDesktop 1.1]
112048
- */
112312
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
112313
+ *
112314
+ * @remarks
112315
+ * [Api set: WordApiDesktop 1.1]
112316
+ */
112049
112317
  listTemplate?: Word.Interfaces.ListTemplateUpdateData;
112050
112318
  /**
112051
- * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
112052
- *
112053
- * @remarks
112054
- * [Api set: WordApi 1.5]
112055
- */
112319
+ * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
112320
+ *
112321
+ * @remarks
112322
+ * [Api set: WordApi 1.5]
112323
+ */
112056
112324
  paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData;
112057
112325
  /**
112058
- * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
112059
- *
112060
- * @remarks
112061
- * [Api set: WordApi 1.6]
112062
- */
112326
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
112327
+ *
112328
+ * @remarks
112329
+ * [Api set: WordApi 1.6]
112330
+ */
112063
112331
  shading?: Word.Interfaces.ShadingUpdateData;
112064
112332
  /**
112065
- * Gets a TableStyle object representing Style properties that can be applied to a table.
112066
- *
112067
- * @remarks
112068
- * [Api set: WordApi 1.6]
112069
- */
112333
+ * Gets a TableStyle object representing Style properties that can be applied to a table.
112334
+ *
112335
+ * @remarks
112336
+ * [Api set: WordApi 1.6]
112337
+ */
112070
112338
  tableStyle?: Word.Interfaces.TableStyleUpdateData;
112071
112339
  /**
112072
112340
  * Specifies the name of an existing style to use as the base formatting of another style.
@@ -112142,11 +112410,11 @@ declare namespace Word {
112142
112410
  /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */
112143
112411
  interface TableUpdateData {
112144
112412
  /**
112145
- * Gets the font. Use this to get and set font name, size, color, and other properties.
112146
- *
112147
- * @remarks
112148
- * [Api set: WordApi 1.3]
112149
- */
112413
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
112414
+ *
112415
+ * @remarks
112416
+ * [Api set: WordApi 1.3]
112417
+ */
112150
112418
  font?: Word.Interfaces.FontUpdateData;
112151
112419
  /**
112152
112420
  * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
@@ -112306,11 +112574,11 @@ declare namespace Word {
112306
112574
  /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */
112307
112575
  interface TableRowUpdateData {
112308
112576
  /**
112309
- * Gets the font. Use this to get and set font name, size, color, and other properties.
112310
- *
112311
- * @remarks
112312
- * [Api set: WordApi 1.3]
112313
- */
112577
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
112578
+ *
112579
+ * @remarks
112580
+ * [Api set: WordApi 1.3]
112581
+ */
112314
112582
  font?: Word.Interfaces.FontUpdateData;
112315
112583
  /**
112316
112584
  * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'.
@@ -112355,11 +112623,11 @@ declare namespace Word {
112355
112623
  /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
112356
112624
  interface TableCellUpdateData {
112357
112625
  /**
112358
- * Gets the body object of the cell.
112359
- *
112360
- * @remarks
112361
- * [Api set: WordApi 1.3]
112362
- */
112626
+ * Gets the body object of the cell.
112627
+ *
112628
+ * @remarks
112629
+ * [Api set: WordApi 1.3]
112630
+ */
112363
112631
  body?: Word.Interfaces.BodyUpdateData;
112364
112632
  /**
112365
112633
  * Specifies the width of the cell's column in points. This is applicable to uniform tables.
@@ -112494,6 +112762,13 @@ declare namespace Word {
112494
112762
  * [Api set: WordApiDesktop 1.2]
112495
112763
  */
112496
112764
  allowOverlap?: boolean;
112765
+ /**
112766
+ * Specifies a string that represents the alternative text associated with the shape.
112767
+ *
112768
+ * @remarks
112769
+ * [Api set: WordApiDesktop 1.2]
112770
+ */
112771
+ altTextDescription?: string;
112497
112772
  /**
112498
112773
  * The geometric shape type of the shape. It will be null if isn't a geometric shape.
112499
112774
  *
@@ -112508,6 +112783,13 @@ declare namespace Word {
112508
112783
  * [Api set: WordApiDesktop 1.2]
112509
112784
  */
112510
112785
  height?: number;
112786
+ /**
112787
+ * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
112788
+ *
112789
+ * @remarks
112790
+ * [Api set: WordApiDesktop 1.2]
112791
+ */
112792
+ heightRelative?: number;
112511
112793
  /**
112512
112794
  * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
112513
112795
  *
@@ -112515,6 +112797,20 @@ declare namespace Word {
112515
112797
  * [Api set: WordApiDesktop 1.2]
112516
112798
  */
112517
112799
  left?: number;
112800
+ /**
112801
+ * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
112802
+ *
112803
+ * @remarks
112804
+ * [Api set: WordApiDesktop 1.2]
112805
+ */
112806
+ leftRelative?: number;
112807
+ /**
112808
+ * Specifies if the aspect ratio of this shape is locked.
112809
+ *
112810
+ * @remarks
112811
+ * [Api set: WordApiDesktop 1.2]
112812
+ */
112813
+ lockAspectRatio?: boolean;
112518
112814
  /**
112519
112815
  * The name of the shape.
112520
112816
  *
@@ -112529,6 +112825,13 @@ declare namespace Word {
112529
112825
  * [Api set: WordApiDesktop 1.2]
112530
112826
  */
112531
112827
  relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
112828
+ /**
112829
+ * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
112830
+ *
112831
+ * @remarks
112832
+ * [Api set: WordApiDesktop 1.2]
112833
+ */
112834
+ relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
112532
112835
  /**
112533
112836
  * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
112534
112837
  *
@@ -112536,6 +112839,20 @@ declare namespace Word {
112536
112839
  * [Api set: WordApiDesktop 1.2]
112537
112840
  */
112538
112841
  relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
112842
+ /**
112843
+ * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
112844
+ *
112845
+ * @remarks
112846
+ * [Api set: WordApiDesktop 1.2]
112847
+ */
112848
+ relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
112849
+ /**
112850
+ * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape.
112851
+ *
112852
+ * @remarks
112853
+ * [Api set: WordApiDesktop 1.2]
112854
+ */
112855
+ rotation?: number;
112539
112856
  /**
112540
112857
  * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
112541
112858
  *
@@ -112543,6 +112860,20 @@ declare namespace Word {
112543
112860
  * [Api set: WordApiDesktop 1.2]
112544
112861
  */
112545
112862
  top?: number;
112863
+ /**
112864
+ * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
112865
+ *
112866
+ * @remarks
112867
+ * [Api set: WordApiDesktop 1.2]
112868
+ */
112869
+ topRelative?: number;
112870
+ /**
112871
+ * Specifies if the shape is visible. Not applicable to inline shapes.
112872
+ *
112873
+ * @remarks
112874
+ * [Api set: WordApiDesktop 1.2]
112875
+ */
112876
+ visible?: boolean;
112546
112877
  /**
112547
112878
  * The width, in points, of the shape.
112548
112879
  *
@@ -112550,6 +112881,13 @@ declare namespace Word {
112550
112881
  * [Api set: WordApiDesktop 1.2]
112551
112882
  */
112552
112883
  width?: number;
112884
+ /**
112885
+ * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
112886
+ *
112887
+ * @remarks
112888
+ * [Api set: WordApiDesktop 1.2]
112889
+ */
112890
+ widthRelative?: number;
112553
112891
  }
112554
112892
  /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */
112555
112893
  interface ShapeGroupUpdateData {
@@ -112558,7 +112896,7 @@ declare namespace Word {
112558
112896
  *
112559
112897
  * @remarks
112560
112898
  * [Api set: WordApiDesktop 1.2]
112561
- */
112899
+ */
112562
112900
  shape?: Word.Interfaces.ShapeUpdateData;
112563
112901
  }
112564
112902
  /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */
@@ -112744,62 +113082,62 @@ declare namespace Word {
112744
113082
  /** An interface describing the data returned by calling `body.toJSON()`. */
112745
113083
  interface BodyData {
112746
113084
  /**
112747
- * Gets the collection of rich text content control objects in the body.
112748
- *
112749
- * @remarks
112750
- * [Api set: WordApi 1.1]
112751
- */
113085
+ * Gets the collection of rich text content control objects in the body.
113086
+ *
113087
+ * @remarks
113088
+ * [Api set: WordApi 1.1]
113089
+ */
112752
113090
  contentControls?: Word.Interfaces.ContentControlData[];
112753
113091
  /**
112754
- * Gets the collection of field objects in the body.
112755
- *
112756
- * @remarks
112757
- * [Api set: WordApi 1.4]
112758
- */
113092
+ * Gets the collection of field objects in the body.
113093
+ *
113094
+ * @remarks
113095
+ * [Api set: WordApi 1.4]
113096
+ */
112759
113097
  fields?: Word.Interfaces.FieldData[];
112760
113098
  /**
112761
- * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
112762
- *
112763
- * @remarks
112764
- * [Api set: WordApi 1.1]
112765
- */
113099
+ * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
113100
+ *
113101
+ * @remarks
113102
+ * [Api set: WordApi 1.1]
113103
+ */
112766
113104
  font?: Word.Interfaces.FontData;
112767
113105
  /**
112768
- * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
112769
- *
112770
- * @remarks
112771
- * [Api set: WordApi 1.1]
112772
- */
113106
+ * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
113107
+ *
113108
+ * @remarks
113109
+ * [Api set: WordApi 1.1]
113110
+ */
112773
113111
  inlinePictures?: Word.Interfaces.InlinePictureData[];
112774
113112
  /**
112775
- * Gets the collection of list objects in the body.
112776
- *
112777
- * @remarks
112778
- * [Api set: WordApi 1.3]
112779
- */
113113
+ * Gets the collection of list objects in the body.
113114
+ *
113115
+ * @remarks
113116
+ * [Api set: WordApi 1.3]
113117
+ */
112780
113118
  lists?: Word.Interfaces.ListData[];
112781
113119
  /**
112782
- * Gets the collection of paragraph objects in the body.
112783
- *
112784
- * @remarks
112785
- * [Api set: WordApi 1.1]
112786
- *
112787
- * 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.
112788
- */
113120
+ * Gets the collection of paragraph objects in the body.
113121
+ *
113122
+ * @remarks
113123
+ * [Api set: WordApi 1.1]
113124
+ *
113125
+ * 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.
113126
+ */
112789
113127
  paragraphs?: Word.Interfaces.ParagraphData[];
112790
113128
  /**
112791
- * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
112792
- *
112793
- * @remarks
112794
- * [Api set: WordApiDesktop 1.2]
112795
- */
113129
+ * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
113130
+ *
113131
+ * @remarks
113132
+ * [Api set: WordApiDesktop 1.2]
113133
+ */
112796
113134
  shapes?: Word.Interfaces.ShapeData[];
112797
113135
  /**
112798
- * Gets the collection of table objects in the body.
112799
- *
112800
- * @remarks
112801
- * [Api set: WordApi 1.3]
112802
- */
113136
+ * Gets the collection of table objects in the body.
113137
+ *
113138
+ * @remarks
113139
+ * [Api set: WordApi 1.3]
113140
+ */
112803
113141
  tables?: Word.Interfaces.TableData[];
112804
113142
  /**
112805
113143
  * 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.
@@ -113056,76 +113394,76 @@ declare namespace Word {
113056
113394
  /** An interface describing the data returned by calling `contentControl.toJSON()`. */
113057
113395
  interface ContentControlData {
113058
113396
  /**
113059
- * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
113060
- *
113061
- * @remarks
113062
- * [Api set: WordApi 1.7]
113063
- */
113397
+ * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
113398
+ *
113399
+ * @remarks
113400
+ * [Api set: WordApi 1.7]
113401
+ */
113064
113402
  checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;
113065
113403
  /**
113066
- * Gets the data of the content control when its type is 'ComboBox'. It's `null` otherwise.
113067
- *
113068
- * @remarks
113069
- * [Api set: WordApi 1.9]
113070
- */
113404
+ * Gets the data of the content control when its type is 'ComboBox'. It's `null` otherwise.
113405
+ *
113406
+ * @remarks
113407
+ * [Api set: WordApi 1.9]
113408
+ */
113071
113409
  comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;
113072
113410
  /**
113073
- * Gets the collection of content control objects in the content control.
113074
- *
113075
- * @remarks
113076
- * [Api set: WordApi 1.1]
113077
- */
113411
+ * Gets the collection of content control objects in the content control.
113412
+ *
113413
+ * @remarks
113414
+ * [Api set: WordApi 1.1]
113415
+ */
113078
113416
  contentControls?: Word.Interfaces.ContentControlData[];
113079
113417
  /**
113080
- * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise.
113081
- *
113082
- * @remarks
113083
- * [Api set: WordApi 1.9]
113084
- */
113418
+ * Gets the data of the content control when its type is 'DropDownList'. It's `null` otherwise.
113419
+ *
113420
+ * @remarks
113421
+ * [Api set: WordApi 1.9]
113422
+ */
113085
113423
  dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;
113086
113424
  /**
113087
- * Gets the collection of field objects in the content control.
113088
- *
113089
- * @remarks
113090
- * [Api set: WordApi 1.4]
113091
- */
113425
+ * Gets the collection of field objects in the content control.
113426
+ *
113427
+ * @remarks
113428
+ * [Api set: WordApi 1.4]
113429
+ */
113092
113430
  fields?: Word.Interfaces.FieldData[];
113093
113431
  /**
113094
- * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
113095
- *
113096
- * @remarks
113097
- * [Api set: WordApi 1.1]
113098
- */
113432
+ * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
113433
+ *
113434
+ * @remarks
113435
+ * [Api set: WordApi 1.1]
113436
+ */
113099
113437
  font?: Word.Interfaces.FontData;
113100
113438
  /**
113101
- * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
113102
- *
113103
- * @remarks
113104
- * [Api set: WordApi 1.1]
113105
- */
113439
+ * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
113440
+ *
113441
+ * @remarks
113442
+ * [Api set: WordApi 1.1]
113443
+ */
113106
113444
  inlinePictures?: Word.Interfaces.InlinePictureData[];
113107
113445
  /**
113108
- * Gets the collection of list objects in the content control.
113109
- *
113110
- * @remarks
113111
- * [Api set: WordApi 1.3]
113112
- */
113446
+ * Gets the collection of list objects in the content control.
113447
+ *
113448
+ * @remarks
113449
+ * [Api set: WordApi 1.3]
113450
+ */
113113
113451
  lists?: Word.Interfaces.ListData[];
113114
113452
  /**
113115
- * Gets the collection of paragraph objects in the content control.
113116
- *
113117
- * @remarks
113118
- * [Api set: WordApi 1.1]
113119
- *
113120
- * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
113121
- */
113453
+ * Gets the collection of paragraph objects in the content control.
113454
+ *
113455
+ * @remarks
113456
+ * [Api set: WordApi 1.1]
113457
+ *
113458
+ * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
113459
+ */
113122
113460
  paragraphs?: Word.Interfaces.ParagraphData[];
113123
113461
  /**
113124
- * Gets the collection of table objects in the content control.
113125
- *
113126
- * @remarks
113127
- * [Api set: WordApi 1.3]
113128
- */
113462
+ * Gets the collection of table objects in the content control.
113463
+ *
113464
+ * @remarks
113465
+ * [Api set: WordApi 1.3]
113466
+ */
113129
113467
  tables?: Word.Interfaces.TableData[];
113130
113468
  /**
113131
113469
  * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
@@ -113835,11 +114173,11 @@ declare namespace Word {
113835
114173
  /** An interface describing the data returned by calling `listLevel.toJSON()`. */
113836
114174
  interface ListLevelData {
113837
114175
  /**
113838
- * Gets a Font object that represents the character formatting of the specified object.
113839
- *
113840
- * @remarks
113841
- * [Api set: WordApiDesktop 1.1]
113842
- */
114176
+ * Gets a Font object that represents the character formatting of the specified object.
114177
+ *
114178
+ * @remarks
114179
+ * [Api set: WordApiDesktop 1.1]
114180
+ */
113843
114181
  font?: Word.Interfaces.FontData;
113844
114182
  /**
113845
114183
  * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
@@ -113919,11 +114257,11 @@ declare namespace Word {
113919
114257
  /** An interface describing the data returned by calling `listTemplate.toJSON()`. */
113920
114258
  interface ListTemplateData {
113921
114259
  /**
113922
- * Gets a ListLevels collection that represents all the levels for the specified ListTemplate.
113923
- *
113924
- * @remarks
113925
- * [Api set: WordApiDesktop 1.1]
113926
- */
114260
+ * Gets a ListLevels collection that represents all the levels for the specified ListTemplate.
114261
+ *
114262
+ * @remarks
114263
+ * [Api set: WordApiDesktop 1.1]
114264
+ */
113927
114265
  listLevels?: Word.Interfaces.ListLevelData[];
113928
114266
  /**
113929
114267
  * Specifies whether the specified ListTemplate object is outline numbered.
@@ -113936,18 +114274,18 @@ declare namespace Word {
113936
114274
  /** An interface describing the data returned by calling `noteItem.toJSON()`. */
113937
114275
  interface NoteItemData {
113938
114276
  /**
113939
- * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
113940
- *
113941
- * @remarks
113942
- * [Api set: WordApi 1.5]
113943
- */
114277
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
114278
+ *
114279
+ * @remarks
114280
+ * [Api set: WordApi 1.5]
114281
+ */
113944
114282
  body?: Word.Interfaces.BodyData;
113945
114283
  /**
113946
- * Represents a footnote or endnote reference in the main document.
113947
- *
113948
- * @remarks
113949
- * [Api set: WordApi 1.5]
113950
- */
114284
+ * Represents a footnote or endnote reference in the main document.
114285
+ *
114286
+ * @remarks
114287
+ * [Api set: WordApi 1.5]
114288
+ */
113951
114289
  reference?: Word.Interfaces.RangeData;
113952
114290
  /**
113953
114291
  * Represents the note item type: footnote or endnote.
@@ -114020,32 +114358,32 @@ declare namespace Word {
114020
114358
  /** An interface describing the data returned by calling `paragraph.toJSON()`. */
114021
114359
  interface ParagraphData {
114022
114360
  /**
114023
- * Gets the collection of fields in the paragraph.
114024
- *
114025
- * @remarks
114026
- * [Api set: WordApi 1.4]
114027
- */
114361
+ * Gets the collection of fields in the paragraph.
114362
+ *
114363
+ * @remarks
114364
+ * [Api set: WordApi 1.4]
114365
+ */
114028
114366
  fields?: Word.Interfaces.FieldData[];
114029
114367
  /**
114030
- * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
114031
- *
114032
- * @remarks
114033
- * [Api set: WordApi 1.1]
114034
- */
114368
+ * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
114369
+ *
114370
+ * @remarks
114371
+ * [Api set: WordApi 1.1]
114372
+ */
114035
114373
  font?: Word.Interfaces.FontData;
114036
114374
  /**
114037
- * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
114038
- *
114039
- * @remarks
114040
- * [Api set: WordApi 1.1]
114041
- */
114375
+ * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
114376
+ *
114377
+ * @remarks
114378
+ * [Api set: WordApi 1.1]
114379
+ */
114042
114380
  inlinePictures?: Word.Interfaces.InlinePictureData[];
114043
114381
  /**
114044
- * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
114045
- *
114046
- * @remarks
114047
- * [Api set: WordApi 1.3]
114048
- */
114382
+ * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
114383
+ *
114384
+ * @remarks
114385
+ * [Api set: WordApi 1.3]
114386
+ */
114049
114387
  listItem?: Word.Interfaces.ListItemData;
114050
114388
  /**
114051
114389
  * 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}.
@@ -114418,11 +114756,11 @@ declare namespace Word {
114418
114756
  /** An interface describing the data returned by calling `section.toJSON()`. */
114419
114757
  interface SectionData {
114420
114758
  /**
114421
- * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
114422
- *
114423
- * @remarks
114424
- * [Api set: WordApi 1.1]
114425
- */
114759
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
114760
+ *
114761
+ * @remarks
114762
+ * [Api set: WordApi 1.1]
114763
+ */
114426
114764
  body?: Word.Interfaces.BodyData;
114427
114765
  }
114428
114766
  /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */
@@ -114457,46 +114795,46 @@ declare namespace Word {
114457
114795
  /** An interface describing the data returned by calling `style.toJSON()`. */
114458
114796
  interface StyleData {
114459
114797
  /**
114460
- * Specifies a BorderCollection object that represents all the borders for the specified style.
114461
- *
114462
- * @remarks
114463
- * [Api set: WordApiDesktop 1.1]
114464
- */
114798
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
114799
+ *
114800
+ * @remarks
114801
+ * [Api set: WordApiDesktop 1.1]
114802
+ */
114465
114803
  borders?: Word.Interfaces.BorderData[];
114466
114804
  /**
114467
- * Gets a font object that represents the character formatting of the specified style.
114468
- *
114469
- * @remarks
114470
- * [Api set: WordApi 1.5]
114471
- */
114805
+ * Gets a font object that represents the character formatting of the specified style.
114806
+ *
114807
+ * @remarks
114808
+ * [Api set: WordApi 1.5]
114809
+ */
114472
114810
  font?: Word.Interfaces.FontData;
114473
114811
  /**
114474
- * Gets a ListTemplate object that represents the list formatting for the specified Style object.
114475
- *
114476
- * @remarks
114477
- * [Api set: WordApiDesktop 1.1]
114478
- */
114812
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
114813
+ *
114814
+ * @remarks
114815
+ * [Api set: WordApiDesktop 1.1]
114816
+ */
114479
114817
  listTemplate?: Word.Interfaces.ListTemplateData;
114480
114818
  /**
114481
- * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
114482
- *
114483
- * @remarks
114484
- * [Api set: WordApi 1.5]
114485
- */
114819
+ * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
114820
+ *
114821
+ * @remarks
114822
+ * [Api set: WordApi 1.5]
114823
+ */
114486
114824
  paragraphFormat?: Word.Interfaces.ParagraphFormatData;
114487
114825
  /**
114488
- * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
114489
- *
114490
- * @remarks
114491
- * [Api set: WordApi 1.6]
114492
- */
114826
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
114827
+ *
114828
+ * @remarks
114829
+ * [Api set: WordApi 1.6]
114830
+ */
114493
114831
  shading?: Word.Interfaces.ShadingData;
114494
114832
  /**
114495
- * Gets a TableStyle object representing Style properties that can be applied to a table.
114496
- *
114497
- * @remarks
114498
- * [Api set: WordApi 1.6]
114499
- */
114833
+ * Gets a TableStyle object representing Style properties that can be applied to a table.
114834
+ *
114835
+ * @remarks
114836
+ * [Api set: WordApi 1.6]
114837
+ */
114500
114838
  tableStyle?: Word.Interfaces.TableStyleData;
114501
114839
  /**
114502
114840
  * Specifies the name of an existing style to use as the base formatting of another style.
@@ -114615,32 +114953,32 @@ declare namespace Word {
114615
114953
  /** An interface describing the data returned by calling `table.toJSON()`. */
114616
114954
  interface TableData {
114617
114955
  /**
114618
- * Gets the collection of field objects in the table.
114619
- *
114620
- * @remarks
114621
- * [Api set: WordApi 1.4]
114622
- */
114956
+ * Gets the collection of field objects in the table.
114957
+ *
114958
+ * @remarks
114959
+ * [Api set: WordApi 1.4]
114960
+ */
114623
114961
  fields?: Word.Interfaces.FieldData[];
114624
114962
  /**
114625
- * Gets the font. Use this to get and set font name, size, color, and other properties.
114626
- *
114627
- * @remarks
114628
- * [Api set: WordApi 1.3]
114629
- */
114963
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
114964
+ *
114965
+ * @remarks
114966
+ * [Api set: WordApi 1.3]
114967
+ */
114630
114968
  font?: Word.Interfaces.FontData;
114631
114969
  /**
114632
- * Gets all of the table rows.
114633
- *
114634
- * @remarks
114635
- * [Api set: WordApi 1.3]
114636
- */
114970
+ * Gets all of the table rows.
114971
+ *
114972
+ * @remarks
114973
+ * [Api set: WordApi 1.3]
114974
+ */
114637
114975
  rows?: Word.Interfaces.TableRowData[];
114638
114976
  /**
114639
- * Gets the child tables nested one level deeper.
114640
- *
114641
- * @remarks
114642
- * [Api set: WordApi 1.3]
114643
- */
114977
+ * Gets the child tables nested one level deeper.
114978
+ *
114979
+ * @remarks
114980
+ * [Api set: WordApi 1.3]
114981
+ */
114644
114982
  tables?: Word.Interfaces.TableData[];
114645
114983
  /**
114646
114984
  * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
@@ -114905,11 +115243,11 @@ declare namespace Word {
114905
115243
  /** An interface describing the data returned by calling `tableCell.toJSON()`. */
114906
115244
  interface TableCellData {
114907
115245
  /**
114908
- * Gets the body object of the cell.
114909
- *
114910
- * @remarks
114911
- * [Api set: WordApi 1.3]
114912
- */
115246
+ * Gets the body object of the cell.
115247
+ *
115248
+ * @remarks
115249
+ * [Api set: WordApi 1.3]
115250
+ */
114913
115251
  body?: Word.Interfaces.BodyData;
114914
115252
  /**
114915
115253
  * Gets the index of the cell in its row.
@@ -115096,6 +115434,13 @@ declare namespace Word {
115096
115434
  * [Api set: WordApiDesktop 1.2]
115097
115435
  */
115098
115436
  allowOverlap?: boolean;
115437
+ /**
115438
+ * Specifies a string that represents the alternative text associated with the shape.
115439
+ *
115440
+ * @remarks
115441
+ * [Api set: WordApiDesktop 1.2]
115442
+ */
115443
+ altTextDescription?: string;
115099
115444
  /**
115100
115445
  * The geometric shape type of the shape. It will be null if isn't a geometric shape.
115101
115446
  *
@@ -115110,6 +115455,13 @@ declare namespace Word {
115110
115455
  * [Api set: WordApiDesktop 1.2]
115111
115456
  */
115112
115457
  height?: number;
115458
+ /**
115459
+ * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
115460
+ *
115461
+ * @remarks
115462
+ * [Api set: WordApiDesktop 1.2]
115463
+ */
115464
+ heightRelative?: number;
115113
115465
  /**
115114
115466
  * Gets an integer that represents the shape identifier.
115115
115467
  *
@@ -115131,6 +115483,20 @@ declare namespace Word {
115131
115483
  * [Api set: WordApiDesktop 1.2]
115132
115484
  */
115133
115485
  left?: number;
115486
+ /**
115487
+ * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
115488
+ *
115489
+ * @remarks
115490
+ * [Api set: WordApiDesktop 1.2]
115491
+ */
115492
+ leftRelative?: number;
115493
+ /**
115494
+ * Specifies if the aspect ratio of this shape is locked.
115495
+ *
115496
+ * @remarks
115497
+ * [Api set: WordApiDesktop 1.2]
115498
+ */
115499
+ lockAspectRatio?: boolean;
115134
115500
  /**
115135
115501
  * The name of the shape.
115136
115502
  *
@@ -115145,6 +115511,13 @@ declare namespace Word {
115145
115511
  * [Api set: WordApiDesktop 1.2]
115146
115512
  */
115147
115513
  relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
115514
+ /**
115515
+ * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
115516
+ *
115517
+ * @remarks
115518
+ * [Api set: WordApiDesktop 1.2]
115519
+ */
115520
+ relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
115148
115521
  /**
115149
115522
  * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
115150
115523
  *
@@ -115152,6 +115525,20 @@ declare namespace Word {
115152
115525
  * [Api set: WordApiDesktop 1.2]
115153
115526
  */
115154
115527
  relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
115528
+ /**
115529
+ * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
115530
+ *
115531
+ * @remarks
115532
+ * [Api set: WordApiDesktop 1.2]
115533
+ */
115534
+ relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
115535
+ /**
115536
+ * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape.
115537
+ *
115538
+ * @remarks
115539
+ * [Api set: WordApiDesktop 1.2]
115540
+ */
115541
+ rotation?: number;
115155
115542
  /**
115156
115543
  * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
115157
115544
  *
@@ -115159,6 +115546,13 @@ declare namespace Word {
115159
115546
  * [Api set: WordApiDesktop 1.2]
115160
115547
  */
115161
115548
  top?: number;
115549
+ /**
115550
+ * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
115551
+ *
115552
+ * @remarks
115553
+ * [Api set: WordApiDesktop 1.2]
115554
+ */
115555
+ topRelative?: number;
115162
115556
  /**
115163
115557
  * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
115164
115558
  *
@@ -115166,6 +115560,13 @@ declare namespace Word {
115166
115560
  * [Api set: WordApiDesktop 1.2]
115167
115561
  */
115168
115562
  type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
115563
+ /**
115564
+ * Specifies if the shape is visible. Not applicable to inline shapes.
115565
+ *
115566
+ * @remarks
115567
+ * [Api set: WordApiDesktop 1.2]
115568
+ */
115569
+ visible?: boolean;
115169
115570
  /**
115170
115571
  * The width, in points, of the shape.
115171
115572
  *
@@ -115173,6 +115574,13 @@ declare namespace Word {
115173
115574
  * [Api set: WordApiDesktop 1.2]
115174
115575
  */
115175
115576
  width?: number;
115577
+ /**
115578
+ * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
115579
+ *
115580
+ * @remarks
115581
+ * [Api set: WordApiDesktop 1.2]
115582
+ */
115583
+ widthRelative?: number;
115176
115584
  }
115177
115585
  /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
115178
115586
  interface ShapeGroupData {
@@ -115387,11 +115795,11 @@ declare namespace Word {
115387
115795
  */
115388
115796
  $all?: boolean;
115389
115797
  /**
115390
- * Gets the range of text that is annotated.
115391
- *
115392
- * @remarks
115393
- * [Api set: WordApi 1.7]
115394
- */
115798
+ * Gets the range of text that is annotated.
115799
+ *
115800
+ * @remarks
115801
+ * [Api set: WordApi 1.7]
115802
+ */
115395
115803
  range?: Word.Interfaces.RangeLoadOptions;
115396
115804
  /**
115397
115805
  * Gets the critique that was passed when the annotation was inserted.
@@ -115413,11 +115821,11 @@ declare namespace Word {
115413
115821
  */
115414
115822
  $all?: boolean;
115415
115823
  /**
115416
- * Gets the critique annotation object.
115417
- *
115418
- * @remarks
115419
- * [Api set: WordApi 1.7]
115420
- */
115824
+ * Gets the critique annotation object.
115825
+ *
115826
+ * @remarks
115827
+ * [Api set: WordApi 1.7]
115828
+ */
115421
115829
  critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
115422
115830
  /**
115423
115831
  * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
@@ -115446,11 +115854,11 @@ declare namespace Word {
115446
115854
  */
115447
115855
  $all?: boolean;
115448
115856
  /**
115449
- * For EACH ITEM in the collection: Gets the critique annotation object.
115450
- *
115451
- * @remarks
115452
- * [Api set: WordApi 1.7]
115453
- */
115857
+ * For EACH ITEM in the collection: Gets the critique annotation object.
115858
+ *
115859
+ * @remarks
115860
+ * [Api set: WordApi 1.7]
115861
+ */
115454
115862
  critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions;
115455
115863
  /**
115456
115864
  * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.
@@ -115479,53 +115887,53 @@ declare namespace Word {
115479
115887
  */
115480
115888
  $all?: boolean;
115481
115889
  /**
115482
- * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
115483
- *
115484
- * @remarks
115485
- * [Api set: WordApi 1.1]
115486
- */
115890
+ * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
115891
+ *
115892
+ * @remarks
115893
+ * [Api set: WordApi 1.1]
115894
+ */
115487
115895
  font?: Word.Interfaces.FontLoadOptions;
115488
115896
  /**
115489
- * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body.
115490
- *
115491
- * @remarks
115492
- * [Api set: WordApi 1.3]
115493
- */
115897
+ * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body.
115898
+ *
115899
+ * @remarks
115900
+ * [Api set: WordApi 1.3]
115901
+ */
115494
115902
  parentBody?: Word.Interfaces.BodyLoadOptions;
115495
115903
  /**
115496
- * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
115497
- *
115498
- * @remarks
115499
- * [Api set: WordApi 1.3]
115500
- */
115904
+ * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
115905
+ *
115906
+ * @remarks
115907
+ * [Api set: WordApi 1.3]
115908
+ */
115501
115909
  parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions;
115502
115910
  /**
115503
- * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control.
115504
- *
115505
- * @remarks
115506
- * [Api set: WordApi 1.1]
115507
- */
115911
+ * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control.
115912
+ *
115913
+ * @remarks
115914
+ * [Api set: WordApi 1.1]
115915
+ */
115508
115916
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
115509
115917
  /**
115510
- * Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
115511
- *
115512
- * @remarks
115513
- * [Api set: WordApi 1.3]
115514
- */
115918
+ * Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
115919
+ *
115920
+ * @remarks
115921
+ * [Api set: WordApi 1.3]
115922
+ */
115515
115923
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
115516
115924
  /**
115517
- * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section.
115518
- *
115519
- * @remarks
115520
- * [Api set: WordApi 1.3]
115521
- */
115925
+ * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section.
115926
+ *
115927
+ * @remarks
115928
+ * [Api set: WordApi 1.3]
115929
+ */
115522
115930
  parentSection?: Word.Interfaces.SectionLoadOptions;
115523
115931
  /**
115524
- * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
115525
- *
115526
- * @remarks
115527
- * [Api set: WordApi 1.3]
115528
- */
115932
+ * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
115933
+ *
115934
+ * @remarks
115935
+ * [Api set: WordApi 1.3]
115936
+ */
115529
115937
  parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;
115530
115938
  /**
115531
115939
  * 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.
@@ -115681,11 +116089,11 @@ declare namespace Word {
115681
116089
  */
115682
116090
  $all?: boolean;
115683
116091
  /**
115684
- * Specifies the comment's content range.
115685
- *
115686
- * @remarks
115687
- * [Api set: WordApi 1.4]
115688
- */
116092
+ * Specifies the comment's content range.
116093
+ *
116094
+ * @remarks
116095
+ * [Api set: WordApi 1.4]
116096
+ */
115689
116097
  contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
115690
116098
  /**
115691
116099
  * Gets the email of the comment's author.
@@ -115742,11 +116150,11 @@ declare namespace Word {
115742
116150
  */
115743
116151
  $all?: boolean;
115744
116152
  /**
115745
- * For EACH ITEM in the collection: Specifies the comment's content range.
115746
- *
115747
- * @remarks
115748
- * [Api set: WordApi 1.4]
115749
- */
116153
+ * For EACH ITEM in the collection: Specifies the comment's content range.
116154
+ *
116155
+ * @remarks
116156
+ * [Api set: WordApi 1.4]
116157
+ */
115750
116158
  contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
115751
116159
  /**
115752
116160
  * For EACH ITEM in the collection: Gets the email of the comment's author.
@@ -115862,18 +116270,18 @@ declare namespace Word {
115862
116270
  */
115863
116271
  $all?: boolean;
115864
116272
  /**
115865
- * Specifies the commentReply's content range.
115866
- *
115867
- * @remarks
115868
- * [Api set: WordApi 1.4]
115869
- */
116273
+ * Specifies the commentReply's content range.
116274
+ *
116275
+ * @remarks
116276
+ * [Api set: WordApi 1.4]
116277
+ */
115870
116278
  contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
115871
116279
  /**
115872
- * Gets the parent comment of this reply.
115873
- *
115874
- * @remarks
115875
- * [Api set: WordApi 1.4]
115876
- */
116280
+ * Gets the parent comment of this reply.
116281
+ *
116282
+ * @remarks
116283
+ * [Api set: WordApi 1.4]
116284
+ */
115877
116285
  parentComment?: Word.Interfaces.CommentLoadOptions;
115878
116286
  /**
115879
116287
  * Gets the email of the comment reply's author.
@@ -115923,18 +116331,18 @@ declare namespace Word {
115923
116331
  */
115924
116332
  $all?: boolean;
115925
116333
  /**
115926
- * For EACH ITEM in the collection: Specifies the commentReply's content range.
115927
- *
115928
- * @remarks
115929
- * [Api set: WordApi 1.4]
115930
- */
116334
+ * For EACH ITEM in the collection: Specifies the commentReply's content range.
116335
+ *
116336
+ * @remarks
116337
+ * [Api set: WordApi 1.4]
116338
+ */
115931
116339
  contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;
115932
116340
  /**
115933
- * For EACH ITEM in the collection: Gets the parent comment of this reply.
115934
- *
115935
- * @remarks
115936
- * [Api set: WordApi 1.4]
115937
- */
116341
+ * For EACH ITEM in the collection: Gets the parent comment of this reply.
116342
+ *
116343
+ * @remarks
116344
+ * [Api set: WordApi 1.4]
116345
+ */
115938
116346
  parentComment?: Word.Interfaces.CommentLoadOptions;
115939
116347
  /**
115940
116348
  * For EACH ITEM in the collection: Gets the email of the comment reply's author.
@@ -115984,67 +116392,67 @@ declare namespace Word {
115984
116392
  */
115985
116393
  $all?: boolean;
115986
116394
  /**
115987
- * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
115988
- *
115989
- * @remarks
115990
- * [Api set: WordApi 1.7]
115991
- */
116395
+ * Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
116396
+ *
116397
+ * @remarks
116398
+ * [Api set: WordApi 1.7]
116399
+ */
115992
116400
  checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
115993
116401
  /**
115994
- * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
115995
- *
115996
- * @remarks
115997
- * [Api set: WordApi 1.1]
115998
- */
116402
+ * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
116403
+ *
116404
+ * @remarks
116405
+ * [Api set: WordApi 1.1]
116406
+ */
115999
116407
  font?: Word.Interfaces.FontLoadOptions;
116000
116408
  /**
116001
- * Gets the parent body of the content control.
116002
- *
116003
- * @remarks
116004
- * [Api set: WordApi 1.3]
116005
- */
116409
+ * Gets the parent body of the content control.
116410
+ *
116411
+ * @remarks
116412
+ * [Api set: WordApi 1.3]
116413
+ */
116006
116414
  parentBody?: Word.Interfaces.BodyLoadOptions;
116007
116415
  /**
116008
- * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
116009
- *
116010
- * @remarks
116011
- * [Api set: WordApi 1.1]
116012
- */
116416
+ * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
116417
+ *
116418
+ * @remarks
116419
+ * [Api set: WordApi 1.1]
116420
+ */
116013
116421
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
116014
116422
  /**
116015
- * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116016
- *
116017
- * @remarks
116018
- * [Api set: WordApi 1.3]
116019
- */
116423
+ * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116424
+ *
116425
+ * @remarks
116426
+ * [Api set: WordApi 1.3]
116427
+ */
116020
116428
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
116021
116429
  /**
116022
- * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
116023
- *
116024
- * @remarks
116025
- * [Api set: WordApi 1.3]
116026
- */
116430
+ * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
116431
+ *
116432
+ * @remarks
116433
+ * [Api set: WordApi 1.3]
116434
+ */
116027
116435
  parentTable?: Word.Interfaces.TableLoadOptions;
116028
116436
  /**
116029
- * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
116030
- *
116031
- * @remarks
116032
- * [Api set: WordApi 1.3]
116033
- */
116437
+ * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
116438
+ *
116439
+ * @remarks
116440
+ * [Api set: WordApi 1.3]
116441
+ */
116034
116442
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
116035
116443
  /**
116036
- * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116037
- *
116038
- * @remarks
116039
- * [Api set: WordApi 1.3]
116040
- */
116444
+ * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116445
+ *
116446
+ * @remarks
116447
+ * [Api set: WordApi 1.3]
116448
+ */
116041
116449
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
116042
116450
  /**
116043
- * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116044
- *
116045
- * @remarks
116046
- * [Api set: WordApi 1.3]
116047
- */
116451
+ * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116452
+ *
116453
+ * @remarks
116454
+ * [Api set: WordApi 1.3]
116455
+ */
116048
116456
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
116049
116457
  /**
116050
116458
  * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
@@ -116157,67 +116565,67 @@ declare namespace Word {
116157
116565
  */
116158
116566
  $all?: boolean;
116159
116567
  /**
116160
- * For EACH ITEM in the collection: Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
116161
- *
116162
- * @remarks
116163
- * [Api set: WordApi 1.7]
116164
- */
116568
+ * For EACH ITEM in the collection: Gets the data of the content control when its type is 'CheckBox'. It's `null` otherwise.
116569
+ *
116570
+ * @remarks
116571
+ * [Api set: WordApi 1.7]
116572
+ */
116165
116573
  checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
116166
116574
  /**
116167
- * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
116168
- *
116169
- * @remarks
116170
- * [Api set: WordApi 1.1]
116171
- */
116575
+ * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
116576
+ *
116577
+ * @remarks
116578
+ * [Api set: WordApi 1.1]
116579
+ */
116172
116580
  font?: Word.Interfaces.FontLoadOptions;
116173
116581
  /**
116174
- * For EACH ITEM in the collection: Gets the parent body of the content control.
116175
- *
116176
- * @remarks
116177
- * [Api set: WordApi 1.3]
116178
- */
116582
+ * For EACH ITEM in the collection: Gets the parent body of the content control.
116583
+ *
116584
+ * @remarks
116585
+ * [Api set: WordApi 1.3]
116586
+ */
116179
116587
  parentBody?: Word.Interfaces.BodyLoadOptions;
116180
116588
  /**
116181
- * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
116182
- *
116183
- * @remarks
116184
- * [Api set: WordApi 1.1]
116185
- */
116589
+ * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
116590
+ *
116591
+ * @remarks
116592
+ * [Api set: WordApi 1.1]
116593
+ */
116186
116594
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
116187
116595
  /**
116188
- * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116189
- *
116190
- * @remarks
116191
- * [Api set: WordApi 1.3]
116192
- */
116596
+ * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116597
+ *
116598
+ * @remarks
116599
+ * [Api set: WordApi 1.3]
116600
+ */
116193
116601
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
116194
116602
  /**
116195
- * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
116196
- *
116197
- * @remarks
116198
- * [Api set: WordApi 1.3]
116199
- */
116603
+ * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
116604
+ *
116605
+ * @remarks
116606
+ * [Api set: WordApi 1.3]
116607
+ */
116200
116608
  parentTable?: Word.Interfaces.TableLoadOptions;
116201
116609
  /**
116202
- * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
116203
- *
116204
- * @remarks
116205
- * [Api set: WordApi 1.3]
116206
- */
116610
+ * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
116611
+ *
116612
+ * @remarks
116613
+ * [Api set: WordApi 1.3]
116614
+ */
116207
116615
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
116208
116616
  /**
116209
- * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116210
- *
116211
- * @remarks
116212
- * [Api set: WordApi 1.3]
116213
- */
116617
+ * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116618
+ *
116619
+ * @remarks
116620
+ * [Api set: WordApi 1.3]
116621
+ */
116214
116622
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
116215
116623
  /**
116216
- * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116217
- *
116218
- * @remarks
116219
- * [Api set: WordApi 1.3]
116220
- */
116624
+ * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116625
+ *
116626
+ * @remarks
116627
+ * [Api set: WordApi 1.3]
116628
+ */
116221
116629
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
116222
116630
  /**
116223
116631
  * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
@@ -116540,18 +116948,18 @@ declare namespace Word {
116540
116948
  */
116541
116949
  $all?: boolean;
116542
116950
  /**
116543
- * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
116544
- *
116545
- * @remarks
116546
- * [Api set: WordApi 1.1]
116547
- */
116951
+ * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
116952
+ *
116953
+ * @remarks
116954
+ * [Api set: WordApi 1.1]
116955
+ */
116548
116956
  body?: Word.Interfaces.BodyLoadOptions;
116549
116957
  /**
116550
- * Gets the properties of the document.
116551
- *
116552
- * @remarks
116553
- * [Api set: WordApi 1.3]
116554
- */
116958
+ * Gets the properties of the document.
116959
+ *
116960
+ * @remarks
116961
+ * [Api set: WordApi 1.3]
116962
+ */
116555
116963
  properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
116556
116964
  /**
116557
116965
  * Specifies the ChangeTracking mode.
@@ -116580,18 +116988,18 @@ declare namespace Word {
116580
116988
  */
116581
116989
  $all?: boolean;
116582
116990
  /**
116583
- * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
116584
- *
116585
- * @remarks
116586
- * [Api set: WordApiHiddenDocument 1.3]
116587
- */
116991
+ * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
116992
+ *
116993
+ * @remarks
116994
+ * [Api set: WordApiHiddenDocument 1.3]
116995
+ */
116588
116996
  body?: Word.Interfaces.BodyLoadOptions;
116589
116997
  /**
116590
- * Gets the properties of the document.
116591
- *
116592
- * @remarks
116593
- * [Api set: WordApiHiddenDocument 1.3]
116594
- */
116998
+ * Gets the properties of the document.
116999
+ *
117000
+ * @remarks
117001
+ * [Api set: WordApiHiddenDocument 1.3]
117002
+ */
116595
117003
  properties?: Word.Interfaces.DocumentPropertiesLoadOptions;
116596
117004
  /**
116597
117005
  * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved.
@@ -116750,60 +117158,60 @@ declare namespace Word {
116750
117158
  */
116751
117159
  $all?: boolean;
116752
117160
  /**
116753
- * Gets the parent body of the field.
116754
- *
116755
- * @remarks
116756
- * [Api set: WordApi 1.4]
116757
- */
117161
+ * Gets the parent body of the field.
117162
+ *
117163
+ * @remarks
117164
+ * [Api set: WordApi 1.4]
117165
+ */
116758
117166
  parentBody?: Word.Interfaces.BodyLoadOptions;
116759
117167
  /**
116760
- * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control.
116761
- *
116762
- * @remarks
116763
- * [Api set: WordApi 1.4]
116764
- */
117168
+ * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control.
117169
+ *
117170
+ * @remarks
117171
+ * [Api set: WordApi 1.4]
117172
+ */
116765
117173
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
116766
117174
  /**
116767
- * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116768
- *
116769
- * @remarks
116770
- * [Api set: WordApi 1.4]
116771
- */
117175
+ * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117176
+ *
117177
+ * @remarks
117178
+ * [Api set: WordApi 1.4]
117179
+ */
116772
117180
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
116773
117181
  /**
116774
- * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
116775
- *
116776
- * @remarks
116777
- * [Api set: WordApi 1.4]
116778
- */
117182
+ * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
117183
+ *
117184
+ * @remarks
117185
+ * [Api set: WordApi 1.4]
117186
+ */
116779
117187
  parentTable?: Word.Interfaces.TableLoadOptions;
116780
117188
  /**
116781
- * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
116782
- *
116783
- * @remarks
116784
- * [Api set: WordApi 1.4]
116785
- */
117189
+ * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
117190
+ *
117191
+ * @remarks
117192
+ * [Api set: WordApi 1.4]
117193
+ */
116786
117194
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
116787
117195
  /**
116788
- * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116789
- *
116790
- * @remarks
116791
- * [Api set: WordApi 1.4]
116792
- */
117196
+ * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117197
+ *
117198
+ * @remarks
117199
+ * [Api set: WordApi 1.4]
117200
+ */
116793
117201
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
116794
117202
  /**
116795
- * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116796
- *
116797
- * @remarks
116798
- * [Api set: WordApi 1.4]
116799
- */
117203
+ * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117204
+ *
117205
+ * @remarks
117206
+ * [Api set: WordApi 1.4]
117207
+ */
116800
117208
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
116801
117209
  /**
116802
- * Gets the field's result data.
116803
- *
116804
- * @remarks
116805
- * [Api set: WordApi 1.4]
116806
- */
117210
+ * Gets the field's result data.
117211
+ *
117212
+ * @remarks
117213
+ * [Api set: WordApi 1.4]
117214
+ */
116807
117215
  result?: Word.Interfaces.RangeLoadOptions;
116808
117216
  /**
116809
117217
  * Specifies the field's code instruction.
@@ -116868,60 +117276,60 @@ declare namespace Word {
116868
117276
  */
116869
117277
  $all?: boolean;
116870
117278
  /**
116871
- * For EACH ITEM in the collection: Gets the parent body of the field.
116872
- *
116873
- * @remarks
116874
- * [Api set: WordApi 1.4]
116875
- */
117279
+ * For EACH ITEM in the collection: Gets the parent body of the field.
117280
+ *
117281
+ * @remarks
117282
+ * [Api set: WordApi 1.4]
117283
+ */
116876
117284
  parentBody?: Word.Interfaces.BodyLoadOptions;
116877
117285
  /**
116878
- * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control.
116879
- *
116880
- * @remarks
116881
- * [Api set: WordApi 1.4]
116882
- */
117286
+ * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control.
117287
+ *
117288
+ * @remarks
117289
+ * [Api set: WordApi 1.4]
117290
+ */
116883
117291
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
116884
117292
  /**
116885
- * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116886
- *
116887
- * @remarks
116888
- * [Api set: WordApi 1.4]
116889
- */
117293
+ * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117294
+ *
117295
+ * @remarks
117296
+ * [Api set: WordApi 1.4]
117297
+ */
116890
117298
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
116891
117299
  /**
116892
- * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
116893
- *
116894
- * @remarks
116895
- * [Api set: WordApi 1.4]
116896
- */
117300
+ * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
117301
+ *
117302
+ * @remarks
117303
+ * [Api set: WordApi 1.4]
117304
+ */
116897
117305
  parentTable?: Word.Interfaces.TableLoadOptions;
116898
117306
  /**
116899
- * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
116900
- *
116901
- * @remarks
116902
- * [Api set: WordApi 1.4]
116903
- */
117307
+ * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
117308
+ *
117309
+ * @remarks
117310
+ * [Api set: WordApi 1.4]
117311
+ */
116904
117312
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
116905
117313
  /**
116906
- * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116907
- *
116908
- * @remarks
116909
- * [Api set: WordApi 1.4]
116910
- */
117314
+ * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117315
+ *
117316
+ * @remarks
117317
+ * [Api set: WordApi 1.4]
117318
+ */
116911
117319
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
116912
117320
  /**
116913
- * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
116914
- *
116915
- * @remarks
116916
- * [Api set: WordApi 1.4]
116917
- */
117321
+ * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117322
+ *
117323
+ * @remarks
117324
+ * [Api set: WordApi 1.4]
117325
+ */
116918
117326
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
116919
117327
  /**
116920
- * For EACH ITEM in the collection: Gets the field's result data.
116921
- *
116922
- * @remarks
116923
- * [Api set: WordApi 1.4]
116924
- */
117328
+ * For EACH ITEM in the collection: Gets the field's result data.
117329
+ *
117330
+ * @remarks
117331
+ * [Api set: WordApi 1.4]
117332
+ */
116925
117333
  result?: Word.Interfaces.RangeLoadOptions;
116926
117334
  /**
116927
117335
  * For EACH ITEM in the collection: Specifies the field's code instruction.
@@ -117077,53 +117485,53 @@ declare namespace Word {
117077
117485
  */
117078
117486
  $all?: boolean;
117079
117487
  /**
117080
- * Gets the parent paragraph that contains the inline image.
117081
- *
117082
- * @remarks
117083
- * [Api set: WordApi 1.2]
117084
- */
117488
+ * Gets the parent paragraph that contains the inline image.
117489
+ *
117490
+ * @remarks
117491
+ * [Api set: WordApi 1.2]
117492
+ */
117085
117493
  paragraph?: Word.Interfaces.ParagraphLoadOptions;
117086
117494
  /**
117087
- * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control.
117088
- *
117089
- * @remarks
117090
- * [Api set: WordApi 1.1]
117091
- */
117495
+ * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control.
117496
+ *
117497
+ * @remarks
117498
+ * [Api set: WordApi 1.1]
117499
+ */
117092
117500
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
117093
117501
  /**
117094
- * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117095
- *
117096
- * @remarks
117097
- * [Api set: WordApi 1.3]
117098
- */
117502
+ * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117503
+ *
117504
+ * @remarks
117505
+ * [Api set: WordApi 1.3]
117506
+ */
117099
117507
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
117100
117508
  /**
117101
- * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
117102
- *
117103
- * @remarks
117104
- * [Api set: WordApi 1.3]
117105
- */
117509
+ * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
117510
+ *
117511
+ * @remarks
117512
+ * [Api set: WordApi 1.3]
117513
+ */
117106
117514
  parentTable?: Word.Interfaces.TableLoadOptions;
117107
117515
  /**
117108
- * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
117109
- *
117110
- * @remarks
117111
- * [Api set: WordApi 1.3]
117112
- */
117516
+ * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
117517
+ *
117518
+ * @remarks
117519
+ * [Api set: WordApi 1.3]
117520
+ */
117113
117521
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
117114
117522
  /**
117115
- * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117116
- *
117117
- * @remarks
117118
- * [Api set: WordApi 1.3]
117119
- */
117523
+ * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117524
+ *
117525
+ * @remarks
117526
+ * [Api set: WordApi 1.3]
117527
+ */
117120
117528
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
117121
117529
  /**
117122
- * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117123
- *
117124
- * @remarks
117125
- * [Api set: WordApi 1.3]
117126
- */
117530
+ * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117531
+ *
117532
+ * @remarks
117533
+ * [Api set: WordApi 1.3]
117534
+ */
117127
117535
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
117128
117536
  /**
117129
117537
  * Specifies a string that represents the alternative text associated with the inline image.
@@ -117187,53 +117595,53 @@ declare namespace Word {
117187
117595
  */
117188
117596
  $all?: boolean;
117189
117597
  /**
117190
- * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.
117191
- *
117192
- * @remarks
117193
- * [Api set: WordApi 1.2]
117194
- */
117598
+ * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.
117599
+ *
117600
+ * @remarks
117601
+ * [Api set: WordApi 1.2]
117602
+ */
117195
117603
  paragraph?: Word.Interfaces.ParagraphLoadOptions;
117196
117604
  /**
117197
- * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control.
117198
- *
117199
- * @remarks
117200
- * [Api set: WordApi 1.1]
117201
- */
117605
+ * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control.
117606
+ *
117607
+ * @remarks
117608
+ * [Api set: WordApi 1.1]
117609
+ */
117202
117610
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
117203
117611
  /**
117204
- * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117205
- *
117206
- * @remarks
117207
- * [Api set: WordApi 1.3]
117208
- */
117612
+ * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117613
+ *
117614
+ * @remarks
117615
+ * [Api set: WordApi 1.3]
117616
+ */
117209
117617
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
117210
117618
  /**
117211
- * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
117212
- *
117213
- * @remarks
117214
- * [Api set: WordApi 1.3]
117215
- */
117619
+ * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
117620
+ *
117621
+ * @remarks
117622
+ * [Api set: WordApi 1.3]
117623
+ */
117216
117624
  parentTable?: Word.Interfaces.TableLoadOptions;
117217
117625
  /**
117218
- * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
117219
- *
117220
- * @remarks
117221
- * [Api set: WordApi 1.3]
117222
- */
117626
+ * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
117627
+ *
117628
+ * @remarks
117629
+ * [Api set: WordApi 1.3]
117630
+ */
117223
117631
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
117224
117632
  /**
117225
- * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117226
- *
117227
- * @remarks
117228
- * [Api set: WordApi 1.3]
117229
- */
117633
+ * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117634
+ *
117635
+ * @remarks
117636
+ * [Api set: WordApi 1.3]
117637
+ */
117230
117638
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
117231
117639
  /**
117232
- * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117233
- *
117234
- * @remarks
117235
- * [Api set: WordApi 1.3]
117236
- */
117640
+ * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117641
+ *
117642
+ * @remarks
117643
+ * [Api set: WordApi 1.3]
117644
+ */
117237
117645
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
117238
117646
  /**
117239
117647
  * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image.
@@ -117396,11 +117804,11 @@ declare namespace Word {
117396
117804
  */
117397
117805
  $all?: boolean;
117398
117806
  /**
117399
- * Gets a Font object that represents the character formatting of the specified object.
117400
- *
117401
- * @remarks
117402
- * [Api set: WordApiDesktop 1.1]
117403
- */
117807
+ * Gets a Font object that represents the character formatting of the specified object.
117808
+ *
117809
+ * @remarks
117810
+ * [Api set: WordApiDesktop 1.1]
117811
+ */
117404
117812
  font?: Word.Interfaces.FontLoadOptions;
117405
117813
  /**
117406
117814
  * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
@@ -117485,11 +117893,11 @@ declare namespace Word {
117485
117893
  */
117486
117894
  $all?: boolean;
117487
117895
  /**
117488
- * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object.
117489
- *
117490
- * @remarks
117491
- * [Api set: WordApiDesktop 1.1]
117492
- */
117896
+ * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object.
117897
+ *
117898
+ * @remarks
117899
+ * [Api set: WordApiDesktop 1.1]
117900
+ */
117493
117901
  font?: Word.Interfaces.FontLoadOptions;
117494
117902
  /**
117495
117903
  * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'.
@@ -117593,18 +118001,18 @@ declare namespace Word {
117593
118001
  */
117594
118002
  $all?: boolean;
117595
118003
  /**
117596
- * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
117597
- *
117598
- * @remarks
117599
- * [Api set: WordApi 1.5]
117600
- */
118004
+ * Represents the body object of the note item. It's the portion of the text within the footnote or endnote.
118005
+ *
118006
+ * @remarks
118007
+ * [Api set: WordApi 1.5]
118008
+ */
117601
118009
  body?: Word.Interfaces.BodyLoadOptions;
117602
118010
  /**
117603
- * Represents a footnote or endnote reference in the main document.
117604
- *
117605
- * @remarks
117606
- * [Api set: WordApi 1.5]
117607
- */
118011
+ * Represents a footnote or endnote reference in the main document.
118012
+ *
118013
+ * @remarks
118014
+ * [Api set: WordApi 1.5]
118015
+ */
117608
118016
  reference?: Word.Interfaces.RangeLoadOptions;
117609
118017
  /**
117610
118018
  * Represents the note item type: footnote or endnote.
@@ -117626,18 +118034,18 @@ declare namespace Word {
117626
118034
  */
117627
118035
  $all?: boolean;
117628
118036
  /**
117629
- * 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.
117630
- *
117631
- * @remarks
117632
- * [Api set: WordApi 1.5]
117633
- */
118037
+ * 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.
118038
+ *
118039
+ * @remarks
118040
+ * [Api set: WordApi 1.5]
118041
+ */
117634
118042
  body?: Word.Interfaces.BodyLoadOptions;
117635
118043
  /**
117636
- * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
117637
- *
117638
- * @remarks
117639
- * [Api set: WordApi 1.5]
117640
- */
118044
+ * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document.
118045
+ *
118046
+ * @remarks
118047
+ * [Api set: WordApi 1.5]
118048
+ */
117641
118049
  reference?: Word.Interfaces.RangeLoadOptions;
117642
118050
  /**
117643
118051
  * For EACH ITEM in the collection: Represents the note item type: footnote or endnote.
@@ -117725,88 +118133,88 @@ declare namespace Word {
117725
118133
  */
117726
118134
  $all?: boolean;
117727
118135
  /**
117728
- * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
117729
- *
117730
- * @remarks
117731
- * [Api set: WordApi 1.1]
117732
- */
118136
+ * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
118137
+ *
118138
+ * @remarks
118139
+ * [Api set: WordApi 1.1]
118140
+ */
117733
118141
  font?: Word.Interfaces.FontLoadOptions;
117734
118142
  /**
117735
- * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
117736
- *
117737
- * @remarks
117738
- * [Api set: WordApi 1.3]
117739
- */
118143
+ * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
118144
+ *
118145
+ * @remarks
118146
+ * [Api set: WordApi 1.3]
118147
+ */
117740
118148
  list?: Word.Interfaces.ListLoadOptions;
117741
118149
  /**
117742
- * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
117743
- *
117744
- * @remarks
117745
- * [Api set: WordApi 1.3]
117746
- */
118150
+ * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
118151
+ *
118152
+ * @remarks
118153
+ * [Api set: WordApi 1.3]
118154
+ */
117747
118155
  listItem?: Word.Interfaces.ListItemLoadOptions;
117748
118156
  /**
117749
- * 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}.
117750
- *
117751
- * @remarks
117752
- * [Api set: WordApi 1.3]
117753
- */
118157
+ * 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}.
118158
+ *
118159
+ * @remarks
118160
+ * [Api set: WordApi 1.3]
118161
+ */
117754
118162
  listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;
117755
118163
  /**
117756
- * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117757
- *
117758
- * @remarks
117759
- * [Api set: WordApi 1.3]
117760
- */
118164
+ * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118165
+ *
118166
+ * @remarks
118167
+ * [Api set: WordApi 1.3]
118168
+ */
117761
118169
  listOrNullObject?: Word.Interfaces.ListLoadOptions;
117762
118170
  /**
117763
- * Gets the parent body of the paragraph.
117764
- *
117765
- * @remarks
117766
- * [Api set: WordApi 1.3]
117767
- */
118171
+ * Gets the parent body of the paragraph.
118172
+ *
118173
+ * @remarks
118174
+ * [Api set: WordApi 1.3]
118175
+ */
117768
118176
  parentBody?: Word.Interfaces.BodyLoadOptions;
117769
118177
  /**
117770
- * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
117771
- *
117772
- * @remarks
117773
- * [Api set: WordApi 1.1]
117774
- */
118178
+ * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
118179
+ *
118180
+ * @remarks
118181
+ * [Api set: WordApi 1.1]
118182
+ */
117775
118183
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
117776
118184
  /**
117777
- * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117778
- *
117779
- * @remarks
117780
- * [Api set: WordApi 1.3]
117781
- */
118185
+ * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118186
+ *
118187
+ * @remarks
118188
+ * [Api set: WordApi 1.3]
118189
+ */
117782
118190
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
117783
118191
  /**
117784
- * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
117785
- *
117786
- * @remarks
117787
- * [Api set: WordApi 1.3]
117788
- */
118192
+ * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
118193
+ *
118194
+ * @remarks
118195
+ * [Api set: WordApi 1.3]
118196
+ */
117789
118197
  parentTable?: Word.Interfaces.TableLoadOptions;
117790
118198
  /**
117791
- * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
117792
- *
117793
- * @remarks
117794
- * [Api set: WordApi 1.3]
117795
- */
118199
+ * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
118200
+ *
118201
+ * @remarks
118202
+ * [Api set: WordApi 1.3]
118203
+ */
117796
118204
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
117797
118205
  /**
117798
- * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117799
- *
117800
- * @remarks
117801
- * [Api set: WordApi 1.3]
117802
- */
118206
+ * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118207
+ *
118208
+ * @remarks
118209
+ * [Api set: WordApi 1.3]
118210
+ */
117803
118211
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
117804
118212
  /**
117805
- * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117806
- *
117807
- * @remarks
117808
- * [Api set: WordApi 1.3]
117809
- */
118213
+ * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118214
+ *
118215
+ * @remarks
118216
+ * [Api set: WordApi 1.3]
118217
+ */
117810
118218
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
117811
118219
  /**
117812
118220
  * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
@@ -117940,88 +118348,88 @@ declare namespace Word {
117940
118348
  */
117941
118349
  $all?: boolean;
117942
118350
  /**
117943
- * For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
117944
- *
117945
- * @remarks
117946
- * [Api set: WordApi 1.1]
117947
- */
118351
+ * For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
118352
+ *
118353
+ * @remarks
118354
+ * [Api set: WordApi 1.1]
118355
+ */
117948
118356
  font?: Word.Interfaces.FontLoadOptions;
117949
118357
  /**
117950
- * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
117951
- *
117952
- * @remarks
117953
- * [Api set: WordApi 1.3]
117954
- */
118358
+ * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
118359
+ *
118360
+ * @remarks
118361
+ * [Api set: WordApi 1.3]
118362
+ */
117955
118363
  list?: Word.Interfaces.ListLoadOptions;
117956
118364
  /**
117957
- * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
117958
- *
117959
- * @remarks
117960
- * [Api set: WordApi 1.3]
117961
- */
118365
+ * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
118366
+ *
118367
+ * @remarks
118368
+ * [Api set: WordApi 1.3]
118369
+ */
117962
118370
  listItem?: Word.Interfaces.ListItemLoadOptions;
117963
118371
  /**
117964
- * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117965
- *
117966
- * @remarks
117967
- * [Api set: WordApi 1.3]
117968
- */
118372
+ * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118373
+ *
118374
+ * @remarks
118375
+ * [Api set: WordApi 1.3]
118376
+ */
117969
118377
  listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;
117970
118378
  /**
117971
- * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117972
- *
117973
- * @remarks
117974
- * [Api set: WordApi 1.3]
117975
- */
118379
+ * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118380
+ *
118381
+ * @remarks
118382
+ * [Api set: WordApi 1.3]
118383
+ */
117976
118384
  listOrNullObject?: Word.Interfaces.ListLoadOptions;
117977
118385
  /**
117978
- * For EACH ITEM in the collection: Gets the parent body of the paragraph.
117979
- *
117980
- * @remarks
117981
- * [Api set: WordApi 1.3]
117982
- */
118386
+ * For EACH ITEM in the collection: Gets the parent body of the paragraph.
118387
+ *
118388
+ * @remarks
118389
+ * [Api set: WordApi 1.3]
118390
+ */
117983
118391
  parentBody?: Word.Interfaces.BodyLoadOptions;
117984
118392
  /**
117985
- * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
117986
- *
117987
- * @remarks
117988
- * [Api set: WordApi 1.1]
117989
- */
118393
+ * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
118394
+ *
118395
+ * @remarks
118396
+ * [Api set: WordApi 1.1]
118397
+ */
117990
118398
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
117991
118399
  /**
117992
- * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
117993
- *
117994
- * @remarks
117995
- * [Api set: WordApi 1.3]
117996
- */
118400
+ * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118401
+ *
118402
+ * @remarks
118403
+ * [Api set: WordApi 1.3]
118404
+ */
117997
118405
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
117998
118406
  /**
117999
- * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
118000
- *
118001
- * @remarks
118002
- * [Api set: WordApi 1.3]
118003
- */
118407
+ * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
118408
+ *
118409
+ * @remarks
118410
+ * [Api set: WordApi 1.3]
118411
+ */
118004
118412
  parentTable?: Word.Interfaces.TableLoadOptions;
118005
118413
  /**
118006
- * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
118007
- *
118008
- * @remarks
118009
- * [Api set: WordApi 1.3]
118010
- */
118414
+ * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
118415
+ *
118416
+ * @remarks
118417
+ * [Api set: WordApi 1.3]
118418
+ */
118011
118419
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
118012
118420
  /**
118013
- * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118014
- *
118015
- * @remarks
118016
- * [Api set: WordApi 1.3]
118017
- */
118421
+ * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118422
+ *
118423
+ * @remarks
118424
+ * [Api set: WordApi 1.3]
118425
+ */
118018
118426
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
118019
118427
  /**
118020
- * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118021
- *
118022
- * @remarks
118023
- * [Api set: WordApi 1.3]
118024
- */
118428
+ * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118429
+ *
118430
+ * @remarks
118431
+ * [Api set: WordApi 1.3]
118432
+ */
118025
118433
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
118026
118434
  /**
118027
118435
  * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
@@ -118265,60 +118673,60 @@ declare namespace Word {
118265
118673
  */
118266
118674
  $all?: boolean;
118267
118675
  /**
118268
- * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
118269
- *
118270
- * @remarks
118271
- * [Api set: WordApi 1.1]
118272
- */
118676
+ * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
118677
+ *
118678
+ * @remarks
118679
+ * [Api set: WordApi 1.1]
118680
+ */
118273
118681
  font?: Word.Interfaces.FontLoadOptions;
118274
118682
  /**
118275
- * Gets the parent body of the range.
118276
- *
118277
- * @remarks
118278
- * [Api set: WordApi 1.3]
118279
- */
118683
+ * Gets the parent body of the range.
118684
+ *
118685
+ * @remarks
118686
+ * [Api set: WordApi 1.3]
118687
+ */
118280
118688
  parentBody?: Word.Interfaces.BodyLoadOptions;
118281
118689
  /**
118282
- * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control.
118283
- *
118284
- * @remarks
118285
- * [Api set: WordApi 1.1]
118286
- */
118690
+ * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control.
118691
+ *
118692
+ * @remarks
118693
+ * [Api set: WordApi 1.1]
118694
+ */
118287
118695
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
118288
118696
  /**
118289
- * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118290
- *
118291
- * @remarks
118292
- * [Api set: WordApi 1.3]
118293
- */
118697
+ * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118698
+ *
118699
+ * @remarks
118700
+ * [Api set: WordApi 1.3]
118701
+ */
118294
118702
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
118295
118703
  /**
118296
- * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
118297
- *
118298
- * @remarks
118299
- * [Api set: WordApi 1.3]
118300
- */
118704
+ * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
118705
+ *
118706
+ * @remarks
118707
+ * [Api set: WordApi 1.3]
118708
+ */
118301
118709
  parentTable?: Word.Interfaces.TableLoadOptions;
118302
118710
  /**
118303
- * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
118304
- *
118305
- * @remarks
118306
- * [Api set: WordApi 1.3]
118307
- */
118711
+ * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
118712
+ *
118713
+ * @remarks
118714
+ * [Api set: WordApi 1.3]
118715
+ */
118308
118716
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
118309
118717
  /**
118310
- * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118311
- *
118312
- * @remarks
118313
- * [Api set: WordApi 1.3]
118314
- */
118718
+ * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118719
+ *
118720
+ * @remarks
118721
+ * [Api set: WordApi 1.3]
118722
+ */
118315
118723
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
118316
118724
  /**
118317
- * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118318
- *
118319
- * @remarks
118320
- * [Api set: WordApi 1.3]
118321
- */
118725
+ * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118726
+ *
118727
+ * @remarks
118728
+ * [Api set: WordApi 1.3]
118729
+ */
118322
118730
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
118323
118731
  /**
118324
118732
  * 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.
@@ -118533,11 +118941,11 @@ declare namespace Word {
118533
118941
  */
118534
118942
  $all?: boolean;
118535
118943
  /**
118536
- * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
118537
- *
118538
- * @remarks
118539
- * [Api set: WordApi 1.1]
118540
- */
118944
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
118945
+ *
118946
+ * @remarks
118947
+ * [Api set: WordApi 1.1]
118948
+ */
118541
118949
  body?: Word.Interfaces.BodyLoadOptions;
118542
118950
  }
118543
118951
  /**
@@ -118552,11 +118960,11 @@ declare namespace Word {
118552
118960
  */
118553
118961
  $all?: boolean;
118554
118962
  /**
118555
- * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata.
118556
- *
118557
- * @remarks
118558
- * [Api set: WordApi 1.1]
118559
- */
118963
+ * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata.
118964
+ *
118965
+ * @remarks
118966
+ * [Api set: WordApi 1.1]
118967
+ */
118560
118968
  body?: Word.Interfaces.BodyLoadOptions;
118561
118969
  }
118562
118970
  /**
@@ -118623,46 +119031,46 @@ declare namespace Word {
118623
119031
  */
118624
119032
  $all?: boolean;
118625
119033
  /**
118626
- * For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style.
118627
- *
118628
- * @remarks
118629
- * [Api set: WordApiDesktop 1.1]
118630
- */
119034
+ * For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style.
119035
+ *
119036
+ * @remarks
119037
+ * [Api set: WordApiDesktop 1.1]
119038
+ */
118631
119039
  borders?: Word.Interfaces.BorderCollectionLoadOptions;
118632
119040
  /**
118633
- * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.
118634
- *
118635
- * @remarks
118636
- * [Api set: WordApi 1.5]
118637
- */
119041
+ * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style.
119042
+ *
119043
+ * @remarks
119044
+ * [Api set: WordApi 1.5]
119045
+ */
118638
119046
  font?: Word.Interfaces.FontLoadOptions;
118639
119047
  /**
118640
- * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object.
118641
- *
118642
- * @remarks
118643
- * [Api set: WordApiDesktop 1.1]
118644
- */
119048
+ * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object.
119049
+ *
119050
+ * @remarks
119051
+ * [Api set: WordApiDesktop 1.1]
119052
+ */
118645
119053
  listTemplate?: Word.Interfaces.ListTemplateLoadOptions;
118646
119054
  /**
118647
- * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
118648
- *
118649
- * @remarks
118650
- * [Api set: WordApi 1.5]
118651
- */
119055
+ * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
119056
+ *
119057
+ * @remarks
119058
+ * [Api set: WordApi 1.5]
119059
+ */
118652
119060
  paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
118653
119061
  /**
118654
- * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
118655
- *
118656
- * @remarks
118657
- * [Api set: WordApi 1.6]
118658
- */
119062
+ * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
119063
+ *
119064
+ * @remarks
119065
+ * [Api set: WordApi 1.6]
119066
+ */
118659
119067
  shading?: Word.Interfaces.ShadingLoadOptions;
118660
119068
  /**
118661
- * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.
118662
- *
118663
- * @remarks
118664
- * [Api set: WordApi 1.6]
118665
- */
119069
+ * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.
119070
+ *
119071
+ * @remarks
119072
+ * [Api set: WordApi 1.6]
119073
+ */
118666
119074
  tableStyle?: Word.Interfaces.TableStyleLoadOptions;
118667
119075
  /**
118668
119076
  * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style.
@@ -118766,46 +119174,46 @@ declare namespace Word {
118766
119174
  */
118767
119175
  $all?: boolean;
118768
119176
  /**
118769
- * Specifies a BorderCollection object that represents all the borders for the specified style.
118770
- *
118771
- * @remarks
118772
- * [Api set: WordApiDesktop 1.1]
118773
- */
119177
+ * Specifies a BorderCollection object that represents all the borders for the specified style.
119178
+ *
119179
+ * @remarks
119180
+ * [Api set: WordApiDesktop 1.1]
119181
+ */
118774
119182
  borders?: Word.Interfaces.BorderCollectionLoadOptions;
118775
119183
  /**
118776
- * Gets a font object that represents the character formatting of the specified style.
118777
- *
118778
- * @remarks
118779
- * [Api set: WordApi 1.5]
118780
- */
119184
+ * Gets a font object that represents the character formatting of the specified style.
119185
+ *
119186
+ * @remarks
119187
+ * [Api set: WordApi 1.5]
119188
+ */
118781
119189
  font?: Word.Interfaces.FontLoadOptions;
118782
119190
  /**
118783
- * Gets a ListTemplate object that represents the list formatting for the specified Style object.
118784
- *
118785
- * @remarks
118786
- * [Api set: WordApiDesktop 1.1]
118787
- */
119191
+ * Gets a ListTemplate object that represents the list formatting for the specified Style object.
119192
+ *
119193
+ * @remarks
119194
+ * [Api set: WordApiDesktop 1.1]
119195
+ */
118788
119196
  listTemplate?: Word.Interfaces.ListTemplateLoadOptions;
118789
119197
  /**
118790
- * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
118791
- *
118792
- * @remarks
118793
- * [Api set: WordApi 1.5]
118794
- */
119198
+ * Gets a ParagraphFormat object that represents the paragraph settings for the specified style.
119199
+ *
119200
+ * @remarks
119201
+ * [Api set: WordApi 1.5]
119202
+ */
118795
119203
  paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;
118796
119204
  /**
118797
- * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
118798
- *
118799
- * @remarks
118800
- * [Api set: WordApi 1.6]
118801
- */
119205
+ * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
119206
+ *
119207
+ * @remarks
119208
+ * [Api set: WordApi 1.6]
119209
+ */
118802
119210
  shading?: Word.Interfaces.ShadingLoadOptions;
118803
119211
  /**
118804
- * Gets a TableStyle object representing Style properties that can be applied to a table.
118805
- *
118806
- * @remarks
118807
- * [Api set: WordApi 1.6]
118808
- */
119212
+ * Gets a TableStyle object representing Style properties that can be applied to a table.
119213
+ *
119214
+ * @remarks
119215
+ * [Api set: WordApi 1.6]
119216
+ */
118809
119217
  tableStyle?: Word.Interfaces.TableStyleLoadOptions;
118810
119218
  /**
118811
119219
  * Specifies the name of an existing style to use as the base formatting of another style.
@@ -118942,60 +119350,60 @@ declare namespace Word {
118942
119350
  */
118943
119351
  $all?: boolean;
118944
119352
  /**
118945
- * Gets the font. Use this to get and set font name, size, color, and other properties.
118946
- *
118947
- * @remarks
118948
- * [Api set: WordApi 1.3]
118949
- */
119353
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
119354
+ *
119355
+ * @remarks
119356
+ * [Api set: WordApi 1.3]
119357
+ */
118950
119358
  font?: Word.Interfaces.FontLoadOptions;
118951
119359
  /**
118952
- * Gets the parent body of the table.
118953
- *
118954
- * @remarks
118955
- * [Api set: WordApi 1.3]
118956
- */
119360
+ * Gets the parent body of the table.
119361
+ *
119362
+ * @remarks
119363
+ * [Api set: WordApi 1.3]
119364
+ */
118957
119365
  parentBody?: Word.Interfaces.BodyLoadOptions;
118958
119366
  /**
118959
- * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control.
118960
- *
118961
- * @remarks
118962
- * [Api set: WordApi 1.3]
118963
- */
119367
+ * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control.
119368
+ *
119369
+ * @remarks
119370
+ * [Api set: WordApi 1.3]
119371
+ */
118964
119372
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
118965
119373
  /**
118966
- * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118967
- *
118968
- * @remarks
118969
- * [Api set: WordApi 1.3]
118970
- */
119374
+ * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119375
+ *
119376
+ * @remarks
119377
+ * [Api set: WordApi 1.3]
119378
+ */
118971
119379
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
118972
119380
  /**
118973
- * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
118974
- *
118975
- * @remarks
118976
- * [Api set: WordApi 1.3]
118977
- */
119381
+ * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
119382
+ *
119383
+ * @remarks
119384
+ * [Api set: WordApi 1.3]
119385
+ */
118978
119386
  parentTable?: Word.Interfaces.TableLoadOptions;
118979
119387
  /**
118980
- * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
118981
- *
118982
- * @remarks
118983
- * [Api set: WordApi 1.3]
118984
- */
119388
+ * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
119389
+ *
119390
+ * @remarks
119391
+ * [Api set: WordApi 1.3]
119392
+ */
118985
119393
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
118986
119394
  /**
118987
- * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118988
- *
118989
- * @remarks
118990
- * [Api set: WordApi 1.3]
118991
- */
119395
+ * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119396
+ *
119397
+ * @remarks
119398
+ * [Api set: WordApi 1.3]
119399
+ */
118992
119400
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
118993
119401
  /**
118994
- * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
118995
- *
118996
- * @remarks
118997
- * [Api set: WordApi 1.3]
118998
- */
119402
+ * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119403
+ *
119404
+ * @remarks
119405
+ * [Api set: WordApi 1.3]
119406
+ */
118999
119407
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
119000
119408
  /**
119001
119409
  * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
@@ -119190,60 +119598,60 @@ declare namespace Word {
119190
119598
  */
119191
119599
  $all?: boolean;
119192
119600
  /**
119193
- * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties.
119194
- *
119195
- * @remarks
119196
- * [Api set: WordApi 1.3]
119197
- */
119601
+ * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties.
119602
+ *
119603
+ * @remarks
119604
+ * [Api set: WordApi 1.3]
119605
+ */
119198
119606
  font?: Word.Interfaces.FontLoadOptions;
119199
119607
  /**
119200
- * For EACH ITEM in the collection: Gets the parent body of the table.
119201
- *
119202
- * @remarks
119203
- * [Api set: WordApi 1.3]
119204
- */
119608
+ * For EACH ITEM in the collection: Gets the parent body of the table.
119609
+ *
119610
+ * @remarks
119611
+ * [Api set: WordApi 1.3]
119612
+ */
119205
119613
  parentBody?: Word.Interfaces.BodyLoadOptions;
119206
119614
  /**
119207
- * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control.
119208
- *
119209
- * @remarks
119210
- * [Api set: WordApi 1.3]
119211
- */
119615
+ * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control.
119616
+ *
119617
+ * @remarks
119618
+ * [Api set: WordApi 1.3]
119619
+ */
119212
119620
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
119213
119621
  /**
119214
- * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119215
- *
119216
- * @remarks
119217
- * [Api set: WordApi 1.3]
119218
- */
119622
+ * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119623
+ *
119624
+ * @remarks
119625
+ * [Api set: WordApi 1.3]
119626
+ */
119219
119627
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
119220
119628
  /**
119221
- * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
119222
- *
119223
- * @remarks
119224
- * [Api set: WordApi 1.3]
119225
- */
119629
+ * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
119630
+ *
119631
+ * @remarks
119632
+ * [Api set: WordApi 1.3]
119633
+ */
119226
119634
  parentTable?: Word.Interfaces.TableLoadOptions;
119227
119635
  /**
119228
- * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
119229
- *
119230
- * @remarks
119231
- * [Api set: WordApi 1.3]
119232
- */
119636
+ * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
119637
+ *
119638
+ * @remarks
119639
+ * [Api set: WordApi 1.3]
119640
+ */
119233
119641
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
119234
119642
  /**
119235
- * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119236
- *
119237
- * @remarks
119238
- * [Api set: WordApi 1.3]
119239
- */
119643
+ * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119644
+ *
119645
+ * @remarks
119646
+ * [Api set: WordApi 1.3]
119647
+ */
119240
119648
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
119241
119649
  /**
119242
- * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119243
- *
119244
- * @remarks
119245
- * [Api set: WordApi 1.3]
119246
- */
119650
+ * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
119651
+ *
119652
+ * @remarks
119653
+ * [Api set: WordApi 1.3]
119654
+ */
119247
119655
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
119248
119656
  /**
119249
119657
  * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'.
@@ -119377,18 +119785,18 @@ declare namespace Word {
119377
119785
  */
119378
119786
  $all?: boolean;
119379
119787
  /**
119380
- * Gets the font. Use this to get and set font name, size, color, and other properties.
119381
- *
119382
- * @remarks
119383
- * [Api set: WordApi 1.3]
119384
- */
119788
+ * Gets the font. Use this to get and set font name, size, color, and other properties.
119789
+ *
119790
+ * @remarks
119791
+ * [Api set: WordApi 1.3]
119792
+ */
119385
119793
  font?: Word.Interfaces.FontLoadOptions;
119386
119794
  /**
119387
- * Gets parent table.
119388
- *
119389
- * @remarks
119390
- * [Api set: WordApi 1.3]
119391
- */
119795
+ * Gets parent table.
119796
+ *
119797
+ * @remarks
119798
+ * [Api set: WordApi 1.3]
119799
+ */
119392
119800
  parentTable?: Word.Interfaces.TableLoadOptions;
119393
119801
  /**
119394
119802
  * Gets the number of cells in the row.
@@ -119459,18 +119867,18 @@ declare namespace Word {
119459
119867
  */
119460
119868
  $all?: boolean;
119461
119869
  /**
119462
- * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties.
119463
- *
119464
- * @remarks
119465
- * [Api set: WordApi 1.3]
119466
- */
119870
+ * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties.
119871
+ *
119872
+ * @remarks
119873
+ * [Api set: WordApi 1.3]
119874
+ */
119467
119875
  font?: Word.Interfaces.FontLoadOptions;
119468
119876
  /**
119469
- * For EACH ITEM in the collection: Gets parent table.
119470
- *
119471
- * @remarks
119472
- * [Api set: WordApi 1.3]
119473
- */
119877
+ * For EACH ITEM in the collection: Gets parent table.
119878
+ *
119879
+ * @remarks
119880
+ * [Api set: WordApi 1.3]
119881
+ */
119474
119882
  parentTable?: Word.Interfaces.TableLoadOptions;
119475
119883
  /**
119476
119884
  * For EACH ITEM in the collection: Gets the number of cells in the row.
@@ -119541,25 +119949,25 @@ declare namespace Word {
119541
119949
  */
119542
119950
  $all?: boolean;
119543
119951
  /**
119544
- * Gets the body object of the cell.
119545
- *
119546
- * @remarks
119547
- * [Api set: WordApi 1.3]
119548
- */
119952
+ * Gets the body object of the cell.
119953
+ *
119954
+ * @remarks
119955
+ * [Api set: WordApi 1.3]
119956
+ */
119549
119957
  body?: Word.Interfaces.BodyLoadOptions;
119550
119958
  /**
119551
- * Gets the parent row of the cell.
119552
- *
119553
- * @remarks
119554
- * [Api set: WordApi 1.3]
119555
- */
119959
+ * Gets the parent row of the cell.
119960
+ *
119961
+ * @remarks
119962
+ * [Api set: WordApi 1.3]
119963
+ */
119556
119964
  parentRow?: Word.Interfaces.TableRowLoadOptions;
119557
119965
  /**
119558
- * Gets the parent table of the cell.
119559
- *
119560
- * @remarks
119561
- * [Api set: WordApi 1.3]
119562
- */
119966
+ * Gets the parent table of the cell.
119967
+ *
119968
+ * @remarks
119969
+ * [Api set: WordApi 1.3]
119970
+ */
119563
119971
  parentTable?: Word.Interfaces.TableLoadOptions;
119564
119972
  /**
119565
119973
  * Gets the index of the cell in its row.
@@ -119630,25 +120038,25 @@ declare namespace Word {
119630
120038
  */
119631
120039
  $all?: boolean;
119632
120040
  /**
119633
- * For EACH ITEM in the collection: Gets the body object of the cell.
119634
- *
119635
- * @remarks
119636
- * [Api set: WordApi 1.3]
119637
- */
120041
+ * For EACH ITEM in the collection: Gets the body object of the cell.
120042
+ *
120043
+ * @remarks
120044
+ * [Api set: WordApi 1.3]
120045
+ */
119638
120046
  body?: Word.Interfaces.BodyLoadOptions;
119639
120047
  /**
119640
- * For EACH ITEM in the collection: Gets the parent row of the cell.
119641
- *
119642
- * @remarks
119643
- * [Api set: WordApi 1.3]
119644
- */
120048
+ * For EACH ITEM in the collection: Gets the parent row of the cell.
120049
+ *
120050
+ * @remarks
120051
+ * [Api set: WordApi 1.3]
120052
+ */
119645
120053
  parentRow?: Word.Interfaces.TableRowLoadOptions;
119646
120054
  /**
119647
- * For EACH ITEM in the collection: Gets the parent table of the cell.
119648
- *
119649
- * @remarks
119650
- * [Api set: WordApi 1.3]
119651
- */
120055
+ * For EACH ITEM in the collection: Gets the parent table of the cell.
120056
+ *
120057
+ * @remarks
120058
+ * [Api set: WordApi 1.3]
120059
+ */
119652
120060
  parentTable?: Word.Interfaces.TableLoadOptions;
119653
120061
  /**
119654
120062
  * For EACH ITEM in the collection: Gets the index of the cell in its row.
@@ -119894,6 +120302,13 @@ declare namespace Word {
119894
120302
  * [Api set: WordApiDesktop 1.2]
119895
120303
  */
119896
120304
  allowOverlap?: boolean;
120305
+ /**
120306
+ * Specifies a string that represents the alternative text associated with the shape.
120307
+ *
120308
+ * @remarks
120309
+ * [Api set: WordApiDesktop 1.2]
120310
+ */
120311
+ altTextDescription?: boolean;
119897
120312
  /**
119898
120313
  * The geometric shape type of the shape. It will be null if isn't a geometric shape.
119899
120314
  *
@@ -119908,6 +120323,13 @@ declare namespace Word {
119908
120323
  * [Api set: WordApiDesktop 1.2]
119909
120324
  */
119910
120325
  height?: boolean;
120326
+ /**
120327
+ * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
120328
+ *
120329
+ * @remarks
120330
+ * [Api set: WordApiDesktop 1.2]
120331
+ */
120332
+ heightRelative?: boolean;
119911
120333
  /**
119912
120334
  * Gets an integer that represents the shape identifier.
119913
120335
  *
@@ -119929,6 +120351,20 @@ declare namespace Word {
119929
120351
  * [Api set: WordApiDesktop 1.2]
119930
120352
  */
119931
120353
  left?: boolean;
120354
+ /**
120355
+ * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
120356
+ *
120357
+ * @remarks
120358
+ * [Api set: WordApiDesktop 1.2]
120359
+ */
120360
+ leftRelative?: boolean;
120361
+ /**
120362
+ * Specifies if the aspect ratio of this shape is locked.
120363
+ *
120364
+ * @remarks
120365
+ * [Api set: WordApiDesktop 1.2]
120366
+ */
120367
+ lockAspectRatio?: boolean;
119932
120368
  /**
119933
120369
  * The name of the shape.
119934
120370
  *
@@ -119943,6 +120379,13 @@ declare namespace Word {
119943
120379
  * [Api set: WordApiDesktop 1.2]
119944
120380
  */
119945
120381
  relativeHorizontalPosition?: boolean;
120382
+ /**
120383
+ * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
120384
+ *
120385
+ * @remarks
120386
+ * [Api set: WordApiDesktop 1.2]
120387
+ */
120388
+ relativeHorizontalSize?: boolean;
119946
120389
  /**
119947
120390
  * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
119948
120391
  *
@@ -119950,6 +120393,20 @@ declare namespace Word {
119950
120393
  * [Api set: WordApiDesktop 1.2]
119951
120394
  */
119952
120395
  relativeVerticalPosition?: boolean;
120396
+ /**
120397
+ * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
120398
+ *
120399
+ * @remarks
120400
+ * [Api set: WordApiDesktop 1.2]
120401
+ */
120402
+ relativeVerticalSize?: boolean;
120403
+ /**
120404
+ * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape.
120405
+ *
120406
+ * @remarks
120407
+ * [Api set: WordApiDesktop 1.2]
120408
+ */
120409
+ rotation?: boolean;
119953
120410
  /**
119954
120411
  * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
119955
120412
  *
@@ -119957,6 +120414,13 @@ declare namespace Word {
119957
120414
  * [Api set: WordApiDesktop 1.2]
119958
120415
  */
119959
120416
  top?: boolean;
120417
+ /**
120418
+ * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
120419
+ *
120420
+ * @remarks
120421
+ * [Api set: WordApiDesktop 1.2]
120422
+ */
120423
+ topRelative?: boolean;
119960
120424
  /**
119961
120425
  * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
119962
120426
  *
@@ -119964,6 +120428,13 @@ declare namespace Word {
119964
120428
  * [Api set: WordApiDesktop 1.2]
119965
120429
  */
119966
120430
  type?: boolean;
120431
+ /**
120432
+ * Specifies if the shape is visible. Not applicable to inline shapes.
120433
+ *
120434
+ * @remarks
120435
+ * [Api set: WordApiDesktop 1.2]
120436
+ */
120437
+ visible?: boolean;
119967
120438
  /**
119968
120439
  * The width, in points, of the shape.
119969
120440
  *
@@ -119971,6 +120442,13 @@ declare namespace Word {
119971
120442
  * [Api set: WordApiDesktop 1.2]
119972
120443
  */
119973
120444
  width?: boolean;
120445
+ /**
120446
+ * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
120447
+ *
120448
+ * @remarks
120449
+ * [Api set: WordApiDesktop 1.2]
120450
+ */
120451
+ widthRelative?: boolean;
119974
120452
  }
119975
120453
  /**
119976
120454
  * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
@@ -120098,6 +120576,13 @@ declare namespace Word {
120098
120576
  * [Api set: WordApiDesktop 1.2]
120099
120577
  */
120100
120578
  allowOverlap?: boolean;
120579
+ /**
120580
+ * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the shape.
120581
+ *
120582
+ * @remarks
120583
+ * [Api set: WordApiDesktop 1.2]
120584
+ */
120585
+ altTextDescription?: boolean;
120101
120586
  /**
120102
120587
  * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
120103
120588
  *
@@ -120112,6 +120597,13 @@ declare namespace Word {
120112
120597
  * [Api set: WordApiDesktop 1.2]
120113
120598
  */
120114
120599
  height?: boolean;
120600
+ /**
120601
+ * For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
120602
+ *
120603
+ * @remarks
120604
+ * [Api set: WordApiDesktop 1.2]
120605
+ */
120606
+ heightRelative?: boolean;
120115
120607
  /**
120116
120608
  * For EACH ITEM in the collection: Gets an integer that represents the shape identifier.
120117
120609
  *
@@ -120133,6 +120625,20 @@ declare namespace Word {
120133
120625
  * [Api set: WordApiDesktop 1.2]
120134
120626
  */
120135
120627
  left?: boolean;
120628
+ /**
120629
+ * For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set.
120630
+ *
120631
+ * @remarks
120632
+ * [Api set: WordApiDesktop 1.2]
120633
+ */
120634
+ leftRelative?: boolean;
120635
+ /**
120636
+ * For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked.
120637
+ *
120638
+ * @remarks
120639
+ * [Api set: WordApiDesktop 1.2]
120640
+ */
120641
+ lockAspectRatio?: boolean;
120136
120642
  /**
120137
120643
  * For EACH ITEM in the collection: The name of the shape.
120138
120644
  *
@@ -120147,6 +120653,13 @@ declare namespace Word {
120147
120653
  * [Api set: WordApiDesktop 1.2]
120148
120654
  */
120149
120655
  relativeHorizontalPosition?: boolean;
120656
+ /**
120657
+ * For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
120658
+ *
120659
+ * @remarks
120660
+ * [Api set: WordApiDesktop 1.2]
120661
+ */
120662
+ relativeHorizontalSize?: boolean;
120150
120663
  /**
120151
120664
  * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
120152
120665
  *
@@ -120154,6 +120667,20 @@ declare namespace Word {
120154
120667
  * [Api set: WordApiDesktop 1.2]
120155
120668
  */
120156
120669
  relativeVerticalPosition?: boolean;
120670
+ /**
120671
+ * For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
120672
+ *
120673
+ * @remarks
120674
+ * [Api set: WordApiDesktop 1.2]
120675
+ */
120676
+ relativeVerticalSize?: boolean;
120677
+ /**
120678
+ * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape.
120679
+ *
120680
+ * @remarks
120681
+ * [Api set: WordApiDesktop 1.2]
120682
+ */
120683
+ rotation?: boolean;
120157
120684
  /**
120158
120685
  * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
120159
120686
  *
@@ -120161,6 +120688,13 @@ declare namespace Word {
120161
120688
  * [Api set: WordApiDesktop 1.2]
120162
120689
  */
120163
120690
  top?: boolean;
120691
+ /**
120692
+ * For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set.
120693
+ *
120694
+ * @remarks
120695
+ * [Api set: WordApiDesktop 1.2]
120696
+ */
120697
+ topRelative?: boolean;
120164
120698
  /**
120165
120699
  * For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
120166
120700
  *
@@ -120168,6 +120702,13 @@ declare namespace Word {
120168
120702
  * [Api set: WordApiDesktop 1.2]
120169
120703
  */
120170
120704
  type?: boolean;
120705
+ /**
120706
+ * For EACH ITEM in the collection: Specifies if the shape is visible. Not applicable to inline shapes.
120707
+ *
120708
+ * @remarks
120709
+ * [Api set: WordApiDesktop 1.2]
120710
+ */
120711
+ visible?: boolean;
120171
120712
  /**
120172
120713
  * For EACH ITEM in the collection: The width, in points, of the shape.
120173
120714
  *
@@ -120175,6 +120716,13 @@ declare namespace Word {
120175
120716
  * [Api set: WordApiDesktop 1.2]
120176
120717
  */
120177
120718
  width?: boolean;
120719
+ /**
120720
+ * For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set.
120721
+ *
120722
+ * @remarks
120723
+ * [Api set: WordApiDesktop 1.2]
120724
+ */
120725
+ widthRelative?: boolean;
120178
120726
  }
120179
120727
  /**
120180
120728
  * Represents the fill formatting of a shape object.
@@ -131376,9 +131924,9 @@ declare namespace PowerPoint {
131376
131924
  expand?: string;
131377
131925
  }): PowerPoint.PlaceholderFormat;
131378
131926
  /**
131379
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
131380
- * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object.
131381
- */
131927
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
131928
+ * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object.
131929
+ */
131382
131930
  toJSON(): PowerPoint.Interfaces.PlaceholderFormatData;
131383
131931
  }
131384
131932
  /**
@@ -134287,9 +134835,9 @@ declare namespace PowerPoint {
134287
134835
  expand?: string;
134288
134836
  }): PowerPoint.ShapeGroup;
134289
134837
  /**
134290
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
134291
- * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
134292
- */
134838
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
134839
+ * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
134840
+ */
134293
134841
  toJSON(): PowerPoint.Interfaces.ShapeGroupData;
134294
134842
  }
134295
134843
  /**