@types/office-js 1.0.430 → 1.0.432

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +165 -165
  3. office-js/package.json +2 -2
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Mon, 30 Sep 2024 17:36:57 GMT
11
+ * Last updated: Tue, 01 Oct 2024 00:33:23 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -7730,7 +7730,7 @@ declare namespace Office {
7730
7730
  *
7731
7731
  * @remarks
7732
7732
  *
7733
- * Files in the "compressed" format will return a byte array that can be transformed to a base64-encoded string if required.
7733
+ * Files in the "compressed" format will return a byte array that can be transformed to a Base64-encoded string if required.
7734
7734
  */
7735
7735
  data: any;
7736
7736
  /**
@@ -8798,7 +8798,7 @@ declare namespace Office {
8798
8798
  */
8799
8799
  enum AttachmentContentFormat {
8800
8800
  /**
8801
- * The content of the attachment is returned as a base64-encoded string.
8801
+ * The content of the attachment is returned as a Base64-encoded string.
8802
8802
  */
8803
8803
  Base64 = "base64",
8804
8804
  /**
@@ -28434,12 +28434,12 @@ declare namespace Excel {
28434
28434
  }
28435
28435
  /**
28436
28436
  *
28437
- * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a base64-encoded .xlsx file.
28437
+ * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file.
28438
28438
  * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed.
28439
- *
28439
+ *
28440
28440
  * [Api set: ExcelApi 1.8]
28441
28441
  *
28442
- * @param base64File Optional. The base64 encoded .xlsx file. The default value is null.
28442
+ * @param base64File Optional. The Base64-encoded .xlsx file. The default value is null.
28443
28443
  */
28444
28444
  function createWorkbook(base64?: string): Promise<void>;
28445
28445
  interface ThreeArrowsSet {
@@ -32013,7 +32013,7 @@ declare namespace Excel {
32013
32013
  * @remarks
32014
32014
  * [Api set: ExcelApi 1.13]
32015
32015
  *
32016
- * @param base64File Required. The base64-encoded string representing the source workbook file.
32016
+ * @param base64File Required. The Base64-encoded string representing the source workbook file.
32017
32017
  * @param options Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook.
32018
32018
  * @returns An array of IDs corresponding to each newly inserted worksheet.
32019
32019
  */
@@ -33921,7 +33921,7 @@ declare namespace Excel {
33921
33921
  */
33922
33922
  getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;
33923
33923
  /**
33924
- * Renders the range as a base64-encoded png image.
33924
+ * Renders the range as a Base64-encoded png image.
33925
33925
  **Important**: This API is currently unsupported in Excel for Mac. Visit {@link https://github.com/OfficeDev/office-js/issues/235 | OfficeDev/office-js Issue #235} for the current status.
33926
33926
  *
33927
33927
  * @remarks
@@ -38496,7 +38496,7 @@ declare namespace Excel {
38496
38496
  */
38497
38497
  getDataTableOrNullObject(): Excel.ChartDataTable;
38498
38498
  /**
38499
- * Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.
38499
+ * Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions.
38500
38500
  The aspect ratio is preserved as part of the resizing.
38501
38501
  *
38502
38502
  * @remarks
@@ -38508,7 +38508,7 @@ declare namespace Excel {
38508
38508
  */
38509
38509
  getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult<string>;
38510
38510
  /**
38511
- * Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.
38511
+ * Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions.
38512
38512
  The aspect ratio is preserved as part of the resizing.
38513
38513
  *
38514
38514
  * @remarks
@@ -50077,12 +50077,12 @@ declare namespace Excel {
50077
50077
  */
50078
50078
  addGroup(values: Array<string | Shape>): Excel.Shape;
50079
50079
  /**
50080
- * Creates an image from a base64-encoded string and adds it to the worksheet. Returns the `Shape` object that represents the new image.
50080
+ * Creates an image from a Base64-encoded string and adds it to the worksheet. Returns the `Shape` object that represents the new image.
50081
50081
  *
50082
50082
  * @remarks
50083
50083
  * [Api set: ExcelApi 1.9]
50084
50084
  *
50085
- * @param base64ImageString A base64-encoded string representing an image in either JPEG or PNG format.
50085
+ * @param base64ImageString A Base64-encoded string representing an image in either JPEG or PNG format.
50086
50086
  */
50087
50087
  addImage(base64ImageString: string): Excel.Shape;
50088
50088
  /**
@@ -50404,7 +50404,7 @@ declare namespace Excel {
50404
50404
  */
50405
50405
  delete(): void;
50406
50406
  /**
50407
- * Converts the shape to an image and returns the image as a base64-encoded string. The DPI is 96. The only supported formats are `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`.
50407
+ * Converts the shape to an image and returns the image as a Base64-encoded string. The DPI is 96. The only supported formats are `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`.
50408
50408
  *
50409
50409
  * @remarks
50410
50410
  * [Api set: ExcelApi 1.9]
@@ -50413,7 +50413,7 @@ declare namespace Excel {
50413
50413
  */
50414
50414
  getAsImage(format: Excel.PictureFormat): OfficeExtension.ClientResult<string>;
50415
50415
  /**
50416
- * Converts the shape to an image and returns the image as a base64-encoded string. The DPI is 96. The only supported formats are `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`.
50416
+ * Converts the shape to an image and returns the image as a Base64-encoded string. The DPI is 96. The only supported formats are `Excel.PictureFormat.BMP`, `Excel.PictureFormat.PNG`, `Excel.PictureFormat.JPEG`, and `Excel.PictureFormat.GIF`.
50417
50417
  *
50418
50418
  * @remarks
50419
50419
  * [Api set: ExcelApi 1.9]
@@ -85911,7 +85911,7 @@ declare namespace Word {
85911
85911
  */
85912
85912
  untrack(): Word.AnnotationCollection;
85913
85913
  /**
85914
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
85914
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
85915
85915
  * 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.
85916
85916
  */
85917
85917
  toJSON(): Word.Interfaces.AnnotationCollectionData;
@@ -85964,7 +85964,7 @@ declare namespace Word {
85964
85964
  */
85965
85965
  static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;
85966
85966
  /**
85967
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
85967
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
85968
85968
  * 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.
85969
85969
  */
85970
85970
  toJSON(): {
@@ -86359,7 +86359,7 @@ declare namespace Word {
86359
86359
  */
86360
86360
  untrack(): Word.Body;
86361
86361
  /**
86362
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
86362
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
86363
86363
  * 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.
86364
86364
  */
86365
86365
  toJSON(): Word.Interfaces.BodyData;
@@ -86446,7 +86446,7 @@ declare namespace Word {
86446
86446
  */
86447
86447
  untrack(): Word.Border;
86448
86448
  /**
86449
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
86449
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
86450
86450
  * 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.
86451
86451
  */
86452
86452
  toJSON(): Word.Interfaces.BorderData;
@@ -86561,7 +86561,7 @@ declare namespace Word {
86561
86561
  */
86562
86562
  untrack(): Word.BorderCollection;
86563
86563
  /**
86564
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
86564
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
86565
86565
  * 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.
86566
86566
  */
86567
86567
  toJSON(): Word.Interfaces.BorderCollectionData;
@@ -86620,7 +86620,7 @@ declare namespace Word {
86620
86620
  */
86621
86621
  untrack(): Word.CheckboxContentControl;
86622
86622
  /**
86623
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
86623
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
86624
86624
  * 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.
86625
86625
  */
86626
86626
  toJSON(): Word.Interfaces.CheckboxContentControlData;
@@ -86751,7 +86751,7 @@ declare namespace Word {
86751
86751
  */
86752
86752
  untrack(): Word.Comment;
86753
86753
  /**
86754
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
86754
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
86755
86755
  * 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.
86756
86756
  */
86757
86757
  toJSON(): Word.Interfaces.CommentData;
@@ -86808,7 +86808,7 @@ declare namespace Word {
86808
86808
  */
86809
86809
  untrack(): Word.CommentCollection;
86810
86810
  /**
86811
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
86811
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
86812
86812
  * 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.
86813
86813
  */
86814
86814
  toJSON(): Word.Interfaces.CommentCollectionData;
@@ -86917,7 +86917,7 @@ declare namespace Word {
86917
86917
  */
86918
86918
  untrack(): Word.CommentContentRange;
86919
86919
  /**
86920
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
86920
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
86921
86921
  * 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.
86922
86922
  */
86923
86923
  toJSON(): Word.Interfaces.CommentContentRangeData;
@@ -87025,7 +87025,7 @@ declare namespace Word {
87025
87025
  */
87026
87026
  untrack(): Word.CommentReply;
87027
87027
  /**
87028
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
87028
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
87029
87029
  * 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.
87030
87030
  */
87031
87031
  toJSON(): Word.Interfaces.CommentReplyData;
@@ -87082,7 +87082,7 @@ declare namespace Word {
87082
87082
  */
87083
87083
  untrack(): Word.CommentReplyCollection;
87084
87084
  /**
87085
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
87085
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
87086
87086
  * 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.
87087
87087
  */
87088
87088
  toJSON(): Word.Interfaces.CommentReplyCollectionData;
@@ -87624,7 +87624,7 @@ declare namespace Word {
87624
87624
  */
87625
87625
  untrack(): Word.ContentControl;
87626
87626
  /**
87627
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
87627
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
87628
87628
  * 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.
87629
87629
  */
87630
87630
  toJSON(): Word.Interfaces.ContentControlData;
@@ -87744,7 +87744,7 @@ declare namespace Word {
87744
87744
  */
87745
87745
  untrack(): Word.ContentControlCollection;
87746
87746
  /**
87747
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
87747
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
87748
87748
  * 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.
87749
87749
  */
87750
87750
  toJSON(): Word.Interfaces.ContentControlCollectionData;
@@ -87841,7 +87841,7 @@ declare namespace Word {
87841
87841
  */
87842
87842
  untrack(): Word.CustomProperty;
87843
87843
  /**
87844
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
87844
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
87845
87845
  * 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.
87846
87846
  */
87847
87847
  toJSON(): Word.Interfaces.CustomPropertyData;
@@ -87926,7 +87926,7 @@ declare namespace Word {
87926
87926
  */
87927
87927
  untrack(): Word.CustomPropertyCollection;
87928
87928
  /**
87929
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
87929
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
87930
87930
  * 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.
87931
87931
  */
87932
87932
  toJSON(): Word.Interfaces.CustomPropertyCollectionData;
@@ -88205,7 +88205,7 @@ declare namespace Word {
88205
88205
  */
88206
88206
  untrack(): Word.CustomXmlPart;
88207
88207
  /**
88208
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
88208
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88209
88209
  * 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.
88210
88210
  */
88211
88211
  toJSON(): Word.Interfaces.CustomXmlPartData;
@@ -88291,7 +88291,7 @@ declare namespace Word {
88291
88291
  */
88292
88292
  untrack(): Word.CustomXmlPartCollection;
88293
88293
  /**
88294
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
88294
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88295
88295
  * 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.
88296
88296
  */
88297
88297
  toJSON(): Word.Interfaces.CustomXmlPartCollectionData;
@@ -88373,7 +88373,7 @@ declare namespace Word {
88373
88373
  */
88374
88374
  untrack(): Word.CustomXmlPartScopedCollection;
88375
88375
  /**
88376
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
88376
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88377
88377
  * 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.
88378
88378
  */
88379
88379
  toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData;
@@ -88473,8 +88473,8 @@ declare namespace Word {
88473
88473
  addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;
88474
88474
  /**
88475
88475
  * Closes the current document.
88476
- *
88477
- * Note: This API isn't supported in Word on the web.
88476
+
88477
+ Note: This API isn't supported in Word on the web.
88478
88478
  *
88479
88479
  * @remarks
88480
88480
  * [Api set: WordApi 1.5]
@@ -88484,8 +88484,8 @@ declare namespace Word {
88484
88484
  close(closeBehavior?: Word.CloseBehavior): void;
88485
88485
  /**
88486
88486
  * Closes the current document.
88487
- *
88488
- * Note: This API isn't supported in Word on the web.
88487
+
88488
+ Note: This API isn't supported in Word on the web.
88489
88489
  *
88490
88490
  * @remarks
88491
88491
  * [Api set: WordApi 1.5]
@@ -88762,7 +88762,7 @@ declare namespace Word {
88762
88762
  */
88763
88763
  untrack(): Word.Document;
88764
88764
  /**
88765
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
88765
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88766
88766
  * 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.
88767
88767
  */
88768
88768
  toJSON(): Word.Interfaces.DocumentData;
@@ -88975,7 +88975,7 @@ declare namespace Word {
88975
88975
  */
88976
88976
  untrack(): Word.DocumentCreated;
88977
88977
  /**
88978
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
88978
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
88979
88979
  * 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.
88980
88980
  */
88981
88981
  toJSON(): Word.Interfaces.DocumentCreatedData;
@@ -89018,7 +89018,7 @@ declare namespace Word {
89018
89018
  */
89019
89019
  category: string;
89020
89020
  /**
89021
- * Specifies the comments of the document.
89021
+ * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document.
89022
89022
  *
89023
89023
  * @remarks
89024
89024
  * [Api set: WordApi 1.3]
@@ -89153,7 +89153,7 @@ declare namespace Word {
89153
89153
  */
89154
89154
  untrack(): Word.DocumentProperties;
89155
89155
  /**
89156
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
89156
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
89157
89157
  * 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.
89158
89158
  */
89159
89159
  toJSON(): Word.Interfaces.DocumentPropertiesData;
@@ -89357,7 +89357,7 @@ declare namespace Word {
89357
89357
  */
89358
89358
  untrack(): Word.Field;
89359
89359
  /**
89360
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
89360
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
89361
89361
  * 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.
89362
89362
  */
89363
89363
  toJSON(): Word.Interfaces.FieldData;
@@ -89429,7 +89429,7 @@ declare namespace Word {
89429
89429
  */
89430
89430
  untrack(): Word.FieldCollection;
89431
89431
  /**
89432
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
89432
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
89433
89433
  * 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.
89434
89434
  */
89435
89435
  toJSON(): Word.Interfaces.FieldCollectionData;
@@ -89558,7 +89558,7 @@ declare namespace Word {
89558
89558
  */
89559
89559
  untrack(): Word.Font;
89560
89560
  /**
89561
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
89561
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
89562
89562
  * 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.
89563
89563
  */
89564
89564
  toJSON(): Word.Interfaces.FontData;
@@ -89842,7 +89842,7 @@ declare namespace Word {
89842
89842
  */
89843
89843
  untrack(): Word.InlinePicture;
89844
89844
  /**
89845
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
89845
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
89846
89846
  * 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.
89847
89847
  */
89848
89848
  toJSON(): Word.Interfaces.InlinePictureData;
@@ -89899,7 +89899,7 @@ declare namespace Word {
89899
89899
  */
89900
89900
  untrack(): Word.InlinePictureCollection;
89901
89901
  /**
89902
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
89902
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
89903
89903
  * 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.
89904
89904
  */
89905
89905
  toJSON(): Word.Interfaces.InlinePictureCollectionData;
@@ -89914,7 +89914,7 @@ declare namespace Word {
89914
89914
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
89915
89915
  context: RequestContext;
89916
89916
  /**
89917
- * Gets paragraphs in the list. Read-only.
89917
+ * Gets paragraphs in the list.
89918
89918
  *
89919
89919
  * @remarks
89920
89920
  * [Api set: WordApi 1.3]
@@ -90124,7 +90124,7 @@ declare namespace Word {
90124
90124
  */
90125
90125
  untrack(): Word.List;
90126
90126
  /**
90127
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90127
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90128
90128
  * 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.
90129
90129
  */
90130
90130
  toJSON(): Word.Interfaces.ListData;
@@ -90208,7 +90208,7 @@ declare namespace Word {
90208
90208
  */
90209
90209
  untrack(): Word.ListCollection;
90210
90210
  /**
90211
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90211
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90212
90212
  * 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.
90213
90213
  */
90214
90214
  toJSON(): Word.Interfaces.ListCollectionData;
@@ -90308,7 +90308,7 @@ declare namespace Word {
90308
90308
  */
90309
90309
  untrack(): Word.ListItem;
90310
90310
  /**
90311
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90311
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90312
90312
  * 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.
90313
90313
  */
90314
90314
  toJSON(): Word.Interfaces.ListItemData;
@@ -90437,7 +90437,7 @@ declare namespace Word {
90437
90437
  */
90438
90438
  untrack(): Word.ListLevel;
90439
90439
  /**
90440
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90440
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90441
90441
  * 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.
90442
90442
  */
90443
90443
  toJSON(): Word.Interfaces.ListLevelData;
@@ -90494,7 +90494,7 @@ declare namespace Word {
90494
90494
  */
90495
90495
  untrack(): Word.ListLevelCollection;
90496
90496
  /**
90497
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90497
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90498
90498
  * 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.
90499
90499
  */
90500
90500
  toJSON(): Word.Interfaces.ListLevelCollectionData;
@@ -90560,7 +90560,7 @@ declare namespace Word {
90560
90560
  */
90561
90561
  untrack(): Word.ListTemplate;
90562
90562
  /**
90563
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90563
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90564
90564
  * 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.
90565
90565
  */
90566
90566
  toJSON(): Word.Interfaces.ListTemplateData;
@@ -90654,7 +90654,7 @@ declare namespace Word {
90654
90654
  */
90655
90655
  untrack(): Word.NoteItem;
90656
90656
  /**
90657
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90657
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90658
90658
  * 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.
90659
90659
  */
90660
90660
  toJSON(): Word.Interfaces.NoteItemData;
@@ -90711,7 +90711,7 @@ declare namespace Word {
90711
90711
  */
90712
90712
  untrack(): Word.NoteItemCollection;
90713
90713
  /**
90714
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
90714
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
90715
90715
  * 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.
90716
90716
  */
90717
90717
  toJSON(): Word.Interfaces.NoteItemCollectionData;
@@ -91317,7 +91317,7 @@ declare namespace Word {
91317
91317
  */
91318
91318
  untrack(): Word.Paragraph;
91319
91319
  /**
91320
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
91320
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
91321
91321
  * 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.
91322
91322
  */
91323
91323
  toJSON(): Word.Interfaces.ParagraphData;
@@ -91388,7 +91388,7 @@ declare namespace Word {
91388
91388
  */
91389
91389
  untrack(): Word.ParagraphCollection;
91390
91390
  /**
91391
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
91391
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
91392
91392
  * 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.
91393
91393
  */
91394
91394
  toJSON(): Word.Interfaces.ParagraphCollectionData;
@@ -91538,7 +91538,7 @@ declare namespace Word {
91538
91538
  */
91539
91539
  untrack(): Word.ParagraphFormat;
91540
91540
  /**
91541
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
91541
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
91542
91542
  * 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.
91543
91543
  */
91544
91544
  toJSON(): Word.Interfaces.ParagraphFormatData;
@@ -92163,7 +92163,7 @@ declare namespace Word {
92163
92163
  */
92164
92164
  untrack(): Word.Range;
92165
92165
  /**
92166
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
92166
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
92167
92167
  * 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.
92168
92168
  */
92169
92169
  toJSON(): Word.Interfaces.RangeData;
@@ -92220,7 +92220,7 @@ declare namespace Word {
92220
92220
  */
92221
92221
  untrack(): Word.RangeCollection;
92222
92222
  /**
92223
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
92223
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
92224
92224
  * 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.
92225
92225
  */
92226
92226
  toJSON(): Word.Interfaces.RangeCollectionData;
@@ -92382,7 +92382,7 @@ declare namespace Word {
92382
92382
  */
92383
92383
  static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions;
92384
92384
  /**
92385
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
92385
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
92386
92386
  * 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.
92387
92387
  */
92388
92388
  toJSON(): Word.Interfaces.SearchOptionsData;
@@ -92571,7 +92571,7 @@ declare namespace Word {
92571
92571
  */
92572
92572
  untrack(): Word.Section;
92573
92573
  /**
92574
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
92574
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
92575
92575
  * 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.
92576
92576
  */
92577
92577
  toJSON(): Word.Interfaces.SectionData;
@@ -92628,7 +92628,7 @@ declare namespace Word {
92628
92628
  */
92629
92629
  untrack(): Word.SectionCollection;
92630
92630
  /**
92631
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
92631
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
92632
92632
  * 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.
92633
92633
  */
92634
92634
  toJSON(): Word.Interfaces.SectionCollectionData;
@@ -92701,7 +92701,7 @@ declare namespace Word {
92701
92701
  */
92702
92702
  untrack(): Word.Setting;
92703
92703
  /**
92704
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
92704
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
92705
92705
  * 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.
92706
92706
  */
92707
92707
  toJSON(): Word.Interfaces.SettingData;
@@ -92786,7 +92786,7 @@ declare namespace Word {
92786
92786
  */
92787
92787
  untrack(): Word.SettingCollection;
92788
92788
  /**
92789
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
92789
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
92790
92790
  * 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.
92791
92791
  */
92792
92792
  toJSON(): Word.Interfaces.SettingCollectionData;
@@ -92863,7 +92863,7 @@ declare namespace Word {
92863
92863
  */
92864
92864
  untrack(): Word.StyleCollection;
92865
92865
  /**
92866
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
92866
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
92867
92867
  * 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.
92868
92868
  */
92869
92869
  toJSON(): Word.Interfaces.StyleCollectionData;
@@ -93045,7 +93045,7 @@ declare namespace Word {
93045
93045
  */
93046
93046
  untrack(): Word.Style;
93047
93047
  /**
93048
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
93048
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
93049
93049
  * 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.
93050
93050
  */
93051
93051
  toJSON(): Word.Interfaces.StyleData;
@@ -93118,7 +93118,7 @@ declare namespace Word {
93118
93118
  */
93119
93119
  untrack(): Word.Shading;
93120
93120
  /**
93121
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
93121
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
93122
93122
  * 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.
93123
93123
  */
93124
93124
  toJSON(): Word.Interfaces.ShadingData;
@@ -93654,7 +93654,7 @@ declare namespace Word {
93654
93654
  */
93655
93655
  untrack(): Word.Table;
93656
93656
  /**
93657
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
93657
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
93658
93658
  * 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.
93659
93659
  */
93660
93660
  toJSON(): Word.Interfaces.TableData;
@@ -93755,7 +93755,7 @@ declare namespace Word {
93755
93755
  */
93756
93756
  untrack(): Word.TableStyle;
93757
93757
  /**
93758
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
93758
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
93759
93759
  * 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.
93760
93760
  */
93761
93761
  toJSON(): Word.Interfaces.TableStyleData;
@@ -93812,7 +93812,7 @@ declare namespace Word {
93812
93812
  */
93813
93813
  untrack(): Word.TableCollection;
93814
93814
  /**
93815
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
93815
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
93816
93816
  * 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.
93817
93817
  */
93818
93818
  toJSON(): Word.Interfaces.TableCollectionData;
@@ -93827,7 +93827,7 @@ declare namespace Word {
93827
93827
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
93828
93828
  context: RequestContext;
93829
93829
  /**
93830
- * Gets cells. Read-only.
93830
+ * Gets cells.
93831
93831
  *
93832
93832
  * @remarks
93833
93833
  * [Api set: WordApi 1.3]
@@ -94107,7 +94107,7 @@ declare namespace Word {
94107
94107
  */
94108
94108
  untrack(): Word.TableRow;
94109
94109
  /**
94110
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94110
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94111
94111
  * 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.
94112
94112
  */
94113
94113
  toJSON(): Word.Interfaces.TableRowData;
@@ -94164,7 +94164,7 @@ declare namespace Word {
94164
94164
  */
94165
94165
  untrack(): Word.TableRowCollection;
94166
94166
  /**
94167
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94167
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94168
94168
  * 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.
94169
94169
  */
94170
94170
  toJSON(): Word.Interfaces.TableRowCollectionData;
@@ -94409,7 +94409,7 @@ declare namespace Word {
94409
94409
  */
94410
94410
  untrack(): Word.TableCell;
94411
94411
  /**
94412
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94412
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94413
94413
  * 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.
94414
94414
  */
94415
94415
  toJSON(): Word.Interfaces.TableCellData;
@@ -94466,7 +94466,7 @@ declare namespace Word {
94466
94466
  */
94467
94467
  untrack(): Word.TableCellCollection;
94468
94468
  /**
94469
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94469
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94470
94470
  * 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.
94471
94471
  */
94472
94472
  toJSON(): Word.Interfaces.TableCellCollectionData;
@@ -94539,7 +94539,7 @@ declare namespace Word {
94539
94539
  */
94540
94540
  untrack(): Word.TableBorder;
94541
94541
  /**
94542
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94542
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94543
94543
  * 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.
94544
94544
  */
94545
94545
  toJSON(): Word.Interfaces.TableBorderData;
@@ -94646,7 +94646,7 @@ declare namespace Word {
94646
94646
  */
94647
94647
  untrack(): Word.TrackedChange;
94648
94648
  /**
94649
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94649
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94650
94650
  * 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.
94651
94651
  */
94652
94652
  toJSON(): Word.Interfaces.TrackedChangeData;
@@ -94717,7 +94717,7 @@ declare namespace Word {
94717
94717
  */
94718
94718
  untrack(): Word.TrackedChangeCollection;
94719
94719
  /**
94720
- * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94720
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
94721
94721
  * 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.
94722
94722
  */
94723
94723
  toJSON(): Word.Interfaces.TrackedChangeCollectionData;
@@ -98853,7 +98853,7 @@ declare namespace Word {
98853
98853
  */
98854
98854
  category?: string;
98855
98855
  /**
98856
- * Specifies the comments of the document.
98856
+ * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document.
98857
98857
  *
98858
98858
  * @remarks
98859
98859
  * [Api set: WordApi 1.3]
@@ -100635,7 +100635,7 @@ declare namespace Word {
100635
100635
  */
100636
100636
  category?: string;
100637
100637
  /**
100638
- * Specifies the comments of the document.
100638
+ * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document.
100639
100639
  *
100640
100640
  * @remarks
100641
100641
  * [Api set: WordApi 1.3]
@@ -100930,7 +100930,7 @@ declare namespace Word {
100930
100930
  /** An interface describing the data returned by calling `list.toJSON()`. */
100931
100931
  interface ListData {
100932
100932
  /**
100933
- * Gets paragraphs in the list. Read-only.
100933
+ * Gets paragraphs in the list.
100934
100934
  *
100935
100935
  * @remarks
100936
100936
  * [Api set: WordApi 1.3]
@@ -101890,7 +101890,7 @@ declare namespace Word {
101890
101890
  /** An interface describing the data returned by calling `tableRow.toJSON()`. */
101891
101891
  interface TableRowData {
101892
101892
  /**
101893
- * Gets cells. Read-only.
101893
+ * Gets cells.
101894
101894
  *
101895
101895
  * @remarks
101896
101896
  * [Api set: WordApi 1.3]
@@ -103293,7 +103293,7 @@ declare namespace Word {
103293
103293
  */
103294
103294
  category?: boolean;
103295
103295
  /**
103296
- * Specifies the comments of the document.
103296
+ * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document.
103297
103297
  *
103298
103298
  * @remarks
103299
103299
  * [Api set: WordApi 1.3]
@@ -116817,7 +116817,7 @@ declare namespace PowerPoint {
116817
116817
  * @remarks
116818
116818
  * [Api set: PowerPointApi 1.2]
116819
116819
  *
116820
- * @param base64File The base64-encoded string representing the source presentation file.
116820
+ * @param base64File The Base64-encoded string representing the source presentation file.
116821
116821
  * @param options The options that define which slides will be inserted, where the new slides will go, and which presentation's formatting will be used.
116822
116822
  */
116823
116823
  insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions): void;
@@ -118022,86 +118022,6 @@ declare namespace PowerPoint {
118022
118022
  */
118023
118023
  width?: number;
118024
118024
  }
118025
- /**
118026
- * Specifies the dash style for a line.
118027
- *
118028
- * @remarks
118029
- * [Api set: PowerPointApi 1.4]
118030
- */
118031
- enum ShapeLineDashStyle {
118032
- /**
118033
- * The dash line pattern
118034
- * @remarks
118035
- * [Api set: PowerPointApi 1.4]
118036
- */
118037
- dash = "Dash",
118038
- /**
118039
- * The dash-dot line pattern
118040
- * @remarks
118041
- * [Api set: PowerPointApi 1.4]
118042
- */
118043
- dashDot = "DashDot",
118044
- /**
118045
- * The dash-dot-dot line pattern
118046
- * @remarks
118047
- * [Api set: PowerPointApi 1.4]
118048
- */
118049
- dashDotDot = "DashDotDot",
118050
- /**
118051
- * The long dash line pattern
118052
- * @remarks
118053
- * [Api set: PowerPointApi 1.4]
118054
- */
118055
- longDash = "LongDash",
118056
- /**
118057
- * The long dash-dot line pattern
118058
- * @remarks
118059
- * [Api set: PowerPointApi 1.4]
118060
- */
118061
- longDashDot = "LongDashDot",
118062
- /**
118063
- * The round dot line pattern
118064
- * @remarks
118065
- * [Api set: PowerPointApi 1.4]
118066
- */
118067
- roundDot = "RoundDot",
118068
- /**
118069
- * The solid line pattern
118070
- * @remarks
118071
- * [Api set: PowerPointApi 1.4]
118072
- */
118073
- solid = "Solid",
118074
- /**
118075
- * The square dot line pattern
118076
- * @remarks
118077
- * [Api set: PowerPointApi 1.4]
118078
- */
118079
- squareDot = "SquareDot",
118080
- /**
118081
- * The long dash-dot-dot line pattern
118082
- * @remarks
118083
- * [Api set: PowerPointApi 1.4]
118084
- */
118085
- longDashDotDot = "LongDashDotDot",
118086
- /**
118087
- * The system dash line pattern
118088
- * @remarks
118089
- * [Api set: PowerPointApi 1.4]
118090
- */
118091
- systemDash = "SystemDash",
118092
- /**
118093
- * The system dot line pattern
118094
- * @remarks
118095
- * [Api set: PowerPointApi 1.4]
118096
- */
118097
- systemDot = "SystemDot",
118098
- /**
118099
- * The system dash-dot line pattern
118100
- * @remarks
118101
- * [Api set: PowerPointApi 1.4]
118102
- */
118103
- systemDashDot = "SystemDashDot",
118104
- }
118105
118025
  /**
118106
118026
  * The type of underline applied to a font.
118107
118027
  *
@@ -118262,6 +118182,86 @@ declare namespace PowerPoint {
118262
118182
  */
118263
118183
  thaiDistributed = "ThaiDistributed",
118264
118184
  }
118185
+ /**
118186
+ * Specifies the dash style for a line.
118187
+ *
118188
+ * @remarks
118189
+ * [Api set: PowerPointApi 1.4]
118190
+ */
118191
+ enum ShapeLineDashStyle {
118192
+ /**
118193
+ * The dash line pattern.
118194
+ * @remarks
118195
+ * [Api set: PowerPointApi 1.4]
118196
+ */
118197
+ dash = "Dash",
118198
+ /**
118199
+ * The dash-dot line pattern.
118200
+ * @remarks
118201
+ * [Api set: PowerPointApi 1.4]
118202
+ */
118203
+ dashDot = "DashDot",
118204
+ /**
118205
+ * The dash-dot-dot line pattern.
118206
+ * @remarks
118207
+ * [Api set: PowerPointApi 1.4]
118208
+ */
118209
+ dashDotDot = "DashDotDot",
118210
+ /**
118211
+ * The long dash line pattern.
118212
+ * @remarks
118213
+ * [Api set: PowerPointApi 1.4]
118214
+ */
118215
+ longDash = "LongDash",
118216
+ /**
118217
+ * The long dash-dot line pattern.
118218
+ * @remarks
118219
+ * [Api set: PowerPointApi 1.4]
118220
+ */
118221
+ longDashDot = "LongDashDot",
118222
+ /**
118223
+ * The round dot line pattern.
118224
+ * @remarks
118225
+ * [Api set: PowerPointApi 1.4]
118226
+ */
118227
+ roundDot = "RoundDot",
118228
+ /**
118229
+ * The solid line pattern.
118230
+ * @remarks
118231
+ * [Api set: PowerPointApi 1.4]
118232
+ */
118233
+ solid = "Solid",
118234
+ /**
118235
+ * The square dot line pattern.
118236
+ * @remarks
118237
+ * [Api set: PowerPointApi 1.4]
118238
+ */
118239
+ squareDot = "SquareDot",
118240
+ /**
118241
+ * The long dash-dot-dot line pattern.
118242
+ * @remarks
118243
+ * [Api set: PowerPointApi 1.4]
118244
+ */
118245
+ longDashDotDot = "LongDashDotDot",
118246
+ /**
118247
+ * The system dash line pattern.
118248
+ * @remarks
118249
+ * [Api set: PowerPointApi 1.4]
118250
+ */
118251
+ systemDash = "SystemDash",
118252
+ /**
118253
+ * The system dot line pattern.
118254
+ * @remarks
118255
+ * [Api set: PowerPointApi 1.4]
118256
+ */
118257
+ systemDot = "SystemDot",
118258
+ /**
118259
+ * The system dash-dot line pattern.
118260
+ * @remarks
118261
+ * [Api set: PowerPointApi 1.4]
118262
+ */
118263
+ systemDashDot = "SystemDashDot",
118264
+ }
118265
118265
  /**
118266
118266
  * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
118267
118267
  If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
@@ -121603,11 +121603,11 @@ declare namespace PowerPoint {
121603
121603
  }
121604
121604
  declare namespace PowerPoint {
121605
121605
  /**
121606
- * Creates and opens a new presentation. Optionally, the presentation can be pre-populated with a base64-encoded .pptx file.
121606
+ * Creates and opens a new presentation. Optionally, the presentation can be pre-populated with a Base64-encoded .pptx file.
121607
121607
  *
121608
121608
  * [Api set: PowerPointApi 1.1]
121609
121609
  *
121610
- * @param base64File Optional. The base64-encoded .pptx file. The default value is null.
121610
+ * @param base64File Optional. The Base64-encoded .pptx file. The default value is null.
121611
121611
  */
121612
121612
  function createPresentation(base64File?: string): Promise<void>;
121613
121613
  }
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.430",
3
+ "version": "1.0.432",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "0112fcb0889c02ade9f01e86a5077e2ff1562c8423e9954717608eba728e864f",
48
+ "typesPublisherContentHash": "a4e9c42a4489b5f50dac50ae21564283afc8fb537c267f60833bbe39a9abebdf",
49
49
  "typeScriptVersion": "4.8"
50
50
  }