@types/office-js 1.0.497 → 1.0.499

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 +217 -225
  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: Fri, 09 May 2025 21:33:06 GMT
11
+ * Last updated: Mon, 12 May 2025 18:02:28 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -92105,7 +92105,7 @@ declare namespace Word {
92105
92105
  * @remarks
92106
92106
  * [Api set: WordApi 1.5]
92107
92107
  *
92108
- * 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.
92108
+ * 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.
92109
92109
  *
92110
92110
  * @param base64File Required. The Base64-encoded content of a .docx file.
92111
92111
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
@@ -92407,7 +92407,7 @@ declare namespace Word {
92407
92407
  * @remarks
92408
92408
  * [Api set: WordApiHiddenDocument 1.5]
92409
92409
  *
92410
- * 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.
92410
+ * 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.
92411
92411
  *
92412
92412
  * @param base64File Required. The Base64-encoded content of a .docx file.
92413
92413
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
@@ -92791,10 +92791,8 @@ declare namespace Word {
92791
92791
  * [Api set: WordApi 1.4]
92792
92792
  *
92793
92793
  * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
92794
- * Support for managing fields is similar to what's available in the Word UI.
92795
- * However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
92796
- * To learn more about Word UI clients that more fully support fields,
92797
- * see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
92794
+ * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
92795
+ * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
92798
92796
  */
92799
92797
  class Field extends OfficeExtension.ClientObject {
92800
92798
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -92995,10 +92993,8 @@ declare namespace Word {
92995
92993
  * [Api set: WordApi 1.4]
92996
92994
  *
92997
92995
  * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
92998
- * Support for managing fields is similar to what's available in the Word UI.
92999
- * However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
93000
- * To learn more about Word UI clients that more fully support fields,
93001
- * see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
92996
+ * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
92997
+ * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
93002
92998
  */
93003
92999
  class FieldCollection extends OfficeExtension.ClientObject {
93004
93000
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -93371,7 +93367,7 @@ declare namespace Word {
93371
93367
  * @remarks
93372
93368
  * [Api set: WordApi 1.2]
93373
93369
  *
93374
- * 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.
93370
+ * 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.
93375
93371
  *
93376
93372
  * @param base64File Required. The Base64-encoded content of a .docx file.
93377
93373
  * @param insertLocation Required. The value must be 'Before' or 'After'.
@@ -95184,7 +95180,7 @@ declare namespace Word {
95184
95180
  * @remarks
95185
95181
  * [Api set: WordApi 1.1]
95186
95182
  *
95187
- * 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.
95183
+ * 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.
95188
95184
  *
95189
95185
  * @param base64File Required. The Base64-encoded content of a .docx file.
95190
95186
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
@@ -99037,7 +99033,7 @@ declare namespace Word {
99037
99033
  */
99038
99034
  rotation: number;
99039
99035
  /**
99040
- * 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.
99036
+ * 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.
99041
99037
  *
99042
99038
  * @remarks
99043
99039
  * [Api set: WordApiDesktop 1.2]
@@ -99783,7 +99779,7 @@ declare namespace Word {
99783
99779
  toJSON(): Word.Interfaces.ShapeTextWrapData;
99784
99780
  }
99785
99781
  /**
99786
- * ChangeTracking mode.
99782
+ * Represents the possible change tracking modes.
99787
99783
  *
99788
99784
  * @remarks
99789
99785
  * [Api set: WordApi 1.4]
@@ -106809,7 +106805,7 @@ declare namespace Word {
106809
106805
  */
106810
106806
  rotation?: number;
106811
106807
  /**
106812
- * 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.
106808
+ * 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.
106813
106809
  *
106814
106810
  * @remarks
106815
106811
  * [Api set: WordApiDesktop 1.2]
@@ -109486,7 +109482,7 @@ declare namespace Word {
109486
109482
  */
109487
109483
  rotation?: number;
109488
109484
  /**
109489
- * 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.
109485
+ * 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.
109490
109486
  *
109491
109487
  * @remarks
109492
109488
  * [Api set: WordApiDesktop 1.2]
@@ -111093,10 +111089,8 @@ declare namespace Word {
111093
111089
  * [Api set: WordApi 1.4]
111094
111090
  *
111095
111091
  * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
111096
- * Support for managing fields is similar to what's available in the Word UI.
111097
- * However, while the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}),
111098
- * the `Addin` field is editable. To learn more about Word UI clients that more fully support fields,
111099
- * see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
111092
+ * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
111093
+ * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
111100
111094
  */
111101
111095
  interface FieldLoadOptions {
111102
111096
  /**
@@ -111210,11 +111204,9 @@ declare namespace Word {
111210
111204
  * @remarks
111211
111205
  * [Api set: WordApi 1.4]
111212
111206
  *
111213
- * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField API` introduced in requirement set 1.5.
111214
- * Support for managing fields is similar to what's available in the Word UI.
111215
- * However, while the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}),
111216
- * the `Addin` field is editable. To learn more about Word UI clients that more fully support fields,
111217
- * see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
111207
+ * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5.
111208
+ * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}).
111209
+ * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}.
111218
111210
  */
111219
111211
  interface FieldCollectionLoadOptions {
111220
111212
  /**
@@ -114337,7 +114329,7 @@ declare namespace Word {
114337
114329
  */
114338
114330
  rotation?: boolean;
114339
114331
  /**
114340
- * 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.
114332
+ * 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.
114341
114333
  *
114342
114334
  * @remarks
114343
114335
  * [Api set: WordApiDesktop 1.2]
@@ -114611,7 +114603,7 @@ declare namespace Word {
114611
114603
  */
114612
114604
  rotation?: boolean;
114613
114605
  /**
114614
- * 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.
114606
+ * 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.
114615
114607
  *
114616
114608
  * @remarks
114617
114609
  * [Api set: WordApiDesktop 1.2]
@@ -127452,12 +127444,12 @@ declare namespace PowerPoint {
127452
127444
  context: RequestContext;
127453
127445
  /**
127454
127446
  * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
127455
- *
127456
- * - `true`: All the text has the **All Caps** attribute.
127457
- *
127458
- * - `false`: None of the text has the **All Caps** attribute.
127459
- *
127460
- * - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
127447
+
127448
+ - `true`: All the text has the **All Caps** attribute.
127449
+
127450
+ - `false`: None of the text has the **All Caps** attribute.
127451
+
127452
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
127461
127453
  *
127462
127454
  * @remarks
127463
127455
  * [Api set: PowerPointApi 1.8]
@@ -127465,12 +127457,12 @@ declare namespace PowerPoint {
127465
127457
  allCaps: boolean | null;
127466
127458
  /**
127467
127459
  * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
127468
- *
127469
- * - `true`: All the text is bold.
127470
- *
127471
- * - `false`: None of the text is bold.
127472
- *
127473
- * - `null`: Returned if some, but not all, of the text is bold.
127460
+
127461
+ - `true`: All the text is bold.
127462
+
127463
+ - `false`: None of the text is bold.
127464
+
127465
+ - `null`: Returned if some, but not all, of the text is bold.
127474
127466
  *
127475
127467
  * @remarks
127476
127468
  * [Api set: PowerPointApi 1.4]
@@ -127485,12 +127477,12 @@ declare namespace PowerPoint {
127485
127477
  color: string | null;
127486
127478
  /**
127487
127479
  * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
127488
- *
127489
- * - `true`: All the text has the **Double strikethrough** attribute.
127490
- *
127491
- * - `false`: None of the text has the **Double strikethrough** attribute.
127492
- *
127493
- * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
127480
+
127481
+ - `true`: All the text has the **Double strikethrough** attribute.
127482
+
127483
+ - `false`: None of the text has the **Double strikethrough** attribute.
127484
+
127485
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
127494
127486
  *
127495
127487
  * @remarks
127496
127488
  * [Api set: PowerPointApi 1.8]
@@ -127498,12 +127490,12 @@ declare namespace PowerPoint {
127498
127490
  doubleStrikethrough: boolean | null;
127499
127491
  /**
127500
127492
  * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
127501
- *
127502
- * - `true`: All the text is italicized.
127503
- *
127504
- * - `false`: None of the text is italicized.
127505
- *
127506
- * - `null`: Returned if some, but not all, of the text is italicized.
127493
+
127494
+ - `true`: All the text is italicized.
127495
+
127496
+ - `false`: None of the text is italicized.
127497
+
127498
+ - `null`: Returned if some, but not all, of the text is italicized.
127507
127499
  *
127508
127500
  * @remarks
127509
127501
  * [Api set: PowerPointApi 1.4]
@@ -127525,12 +127517,12 @@ declare namespace PowerPoint {
127525
127517
  size: number | null;
127526
127518
  /**
127527
127519
  * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
127528
- *
127529
- * - `true`: All the text has the **Small Caps** attribute.
127530
- *
127531
- * - `false`: None of the text has the **Small Caps** attribute.
127532
- *
127533
- * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
127520
+
127521
+ - `true`: All the text has the **Small Caps** attribute.
127522
+
127523
+ - `false`: None of the text has the **Small Caps** attribute.
127524
+
127525
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
127534
127526
  *
127535
127527
  * @remarks
127536
127528
  * [Api set: PowerPointApi 1.8]
@@ -127538,12 +127530,12 @@ declare namespace PowerPoint {
127538
127530
  smallCaps: boolean | null;
127539
127531
  /**
127540
127532
  * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
127541
- *
127542
- * - `true`: All the text has the **Strikethrough** attribute.
127543
- *
127544
- * - `false`: None of the text has the **Strikethrough** attribute.
127545
- *
127546
- * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
127533
+
127534
+ - `true`: All the text has the **Strikethrough** attribute.
127535
+
127536
+ - `false`: None of the text has the **Strikethrough** attribute.
127537
+
127538
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
127547
127539
  *
127548
127540
  * @remarks
127549
127541
  * [Api set: PowerPointApi 1.8]
@@ -127551,12 +127543,12 @@ declare namespace PowerPoint {
127551
127543
  strikethrough: boolean | null;
127552
127544
  /**
127553
127545
  * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
127554
- *
127555
- * - `true`: All the text has the **Subscript** attribute.
127556
- *
127557
- * - `false`: None of the text has the **Subscript** attribute.
127558
- *
127559
- * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
127546
+
127547
+ - `true`: All the text has the **Subscript** attribute.
127548
+
127549
+ - `false`: None of the text has the **Subscript** attribute.
127550
+
127551
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
127560
127552
  *
127561
127553
  * @remarks
127562
127554
  * [Api set: PowerPointApi 1.8]
@@ -127564,12 +127556,12 @@ declare namespace PowerPoint {
127564
127556
  subscript: boolean | null;
127565
127557
  /**
127566
127558
  * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
127567
- *
127568
- * - `true`: All the text has the **Superscript** attribute.
127569
- *
127570
- * - `false`: None of the text has the **Superscript** attribute.
127571
- *
127572
- * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
127559
+
127560
+ - `true`: All the text has the **Superscript** attribute.
127561
+
127562
+ - `false`: None of the text has the **Superscript** attribute.
127563
+
127564
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
127573
127565
  *
127574
127566
  * @remarks
127575
127567
  * [Api set: PowerPointApi 1.8]
@@ -128896,7 +128888,7 @@ declare namespace PowerPoint {
128896
128888
  */
128897
128889
  getItemAt(index: number): PowerPoint.SlideLayout;
128898
128890
  /**
128899
- * Gets a layout using its unique ID. If such a layout doesn't exist, an object with an `isNullObject` property set to true is returned. For further information,
128891
+ * Gets a layout using its unique ID. If such a layout doesn't exist, an object with an `isNullObject` property set to true is returned. For further information,
128900
128892
  see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
128901
128893
  *
128902
128894
  * @remarks
@@ -129240,7 +129232,7 @@ declare namespace PowerPoint {
129240
129232
  * [Api set: PowerPointApi 1.8]
129241
129233
  *
129242
129234
  * @param options Optional. Options to specify the desired size of the slide image.
129243
- * @returns A Base64 string of the slide image in PNG format.
129235
+ * @returns A Base64-encoded string of the slide image in PNG format.
129244
129236
  */
129245
129237
  getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;
129246
129238
  /**
@@ -129647,7 +129639,7 @@ declare namespace PowerPoint {
129647
129639
  * @remarks
129648
129640
  * [Api set: PowerPointApi 1.4]
129649
129641
  */
129650
- horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
129642
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
129651
129643
  /**
129652
129644
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
129653
129645
  *
@@ -130989,12 +130981,12 @@ declare namespace PowerPoint {
130989
130981
  interface ShapeFontUpdateData {
130990
130982
  /**
130991
130983
  * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
130992
- *
130993
- * - `true`: All the text has the **All Caps** attribute.
130994
- *
130995
- * - `false`: None of the text has the **All Caps**attribute.
130996
- *
130997
- * - `null`: Some, but not all, of the text has the **All Caps** attribute.
130984
+
130985
+ - `true`: All the text has the **All Caps** attribute.
130986
+
130987
+ - `false`: None of the text has the **All Caps** attribute.
130988
+
130989
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
130998
130990
  *
130999
130991
  * @remarks
131000
130992
  * [Api set: PowerPointApi 1.8]
@@ -131002,12 +130994,12 @@ declare namespace PowerPoint {
131002
130994
  allCaps?: boolean | null;
131003
130995
  /**
131004
130996
  * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
131005
- *
131006
- * - `true`: All the text is bold.
131007
- *
131008
- * - `false`: None of the text is bold.
131009
- *
131010
- * - `null`: Returned if some, but not all, of the text is bold.
130997
+
130998
+ - `true`: All the text is bold.
130999
+
131000
+ - `false`: None of the text is bold.
131001
+
131002
+ - `null`: Returned if some, but not all, of the text is bold.
131011
131003
  *
131012
131004
  * @remarks
131013
131005
  * [Api set: PowerPointApi 1.4]
@@ -131022,12 +131014,12 @@ declare namespace PowerPoint {
131022
131014
  color?: string | null;
131023
131015
  /**
131024
131016
  * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
131025
- *
131026
- * - `true`: All the text has the **Double strikethrough** attribute.
131027
- *
131028
- * - `false`: None of the text has the **Double strikethrough** attribute.
131029
- *
131030
- * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
131017
+
131018
+ - `true`: All the text has the **Double strikethrough** attribute.
131019
+
131020
+ - `false`: None of the text has the **Double strikethrough** attribute.
131021
+
131022
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
131031
131023
  *
131032
131024
  * @remarks
131033
131025
  * [Api set: PowerPointApi 1.8]
@@ -131035,12 +131027,12 @@ declare namespace PowerPoint {
131035
131027
  doubleStrikethrough?: boolean | null;
131036
131028
  /**
131037
131029
  * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
131038
- *
131039
- * - `true`: All the text is italicized.
131040
- *
131041
- * - `false`: None of the text is italicized.
131042
- *
131043
- * - `null`: Returned if some, but not all, of the text is italicized.
131030
+
131031
+ - `true`: All the text is italicized.
131032
+
131033
+ - `false`: None of the text is italicized.
131034
+
131035
+ - `null`: Returned if some, but not all, of the text is italicized.
131044
131036
  *
131045
131037
  * @remarks
131046
131038
  * [Api set: PowerPointApi 1.4]
@@ -131062,12 +131054,12 @@ declare namespace PowerPoint {
131062
131054
  size?: number | null;
131063
131055
  /**
131064
131056
  * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
131065
- *
131066
- * - `true`: All the text has the **Small Caps** attribute.
131067
- *
131068
- * - `false`: None of the text has the **Small Caps** attribute.
131069
- *
131070
- * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
131057
+
131058
+ - `true`: All the text has the **Small Caps** attribute.
131059
+
131060
+ - `false`: None of the text has the **Small Caps** attribute.
131061
+
131062
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
131071
131063
  *
131072
131064
  * @remarks
131073
131065
  * [Api set: PowerPointApi 1.8]
@@ -131075,12 +131067,12 @@ declare namespace PowerPoint {
131075
131067
  smallCaps?: boolean | null;
131076
131068
  /**
131077
131069
  * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
131078
- *
131079
- * - `true`: All the text has the **Strikethrough** attribute.
131080
- *
131081
- * - `false`: None of the text has the **Strikethrough** attribute.
131082
- *
131083
- * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
131070
+
131071
+ - `true`: All the text has the **Strikethrough** attribute.
131072
+
131073
+ - `false`: None of the text has the **Strikethrough** attribute.
131074
+
131075
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
131084
131076
  *
131085
131077
  * @remarks
131086
131078
  * [Api set: PowerPointApi 1.8]
@@ -131088,12 +131080,12 @@ declare namespace PowerPoint {
131088
131080
  strikethrough?: boolean | null;
131089
131081
  /**
131090
131082
  * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
131091
- *
131092
- * - `true`: All the text has the **Subscript** attribute.
131093
- *
131094
- * - `false`: None of the text has the **Subscript** attribute.
131095
- *
131096
- * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
131083
+
131084
+ - `true`: All the text has the **Subscript** attribute.
131085
+
131086
+ - `false`: None of the text has the **Subscript** attribute.
131087
+
131088
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
131097
131089
  *
131098
131090
  * @remarks
131099
131091
  * [Api set: PowerPointApi 1.8]
@@ -131101,12 +131093,12 @@ declare namespace PowerPoint {
131101
131093
  subscript?: boolean | null;
131102
131094
  /**
131103
131095
  * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
131104
- *
131105
- * - `true`: All the text has the **Superscript** attribute.
131106
- *
131107
- * - `false`: None of the text has the **Superscript** attribute.
131108
- *
131109
- * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
131096
+
131097
+ - `true`: All the text has the **Superscript** attribute.
131098
+
131099
+ - `false`: None of the text has the **Superscript** attribute.
131100
+
131101
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
131110
131102
  *
131111
131103
  * @remarks
131112
131104
  * [Api set: PowerPointApi 1.8]
@@ -131223,7 +131215,7 @@ declare namespace PowerPoint {
131223
131215
  * @remarks
131224
131216
  * [Api set: PowerPointApi 1.4]
131225
131217
  */
131226
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
131218
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
131227
131219
  }
131228
131220
  /** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */
131229
131221
  interface TextRangeUpdateData {
@@ -131541,12 +131533,12 @@ declare namespace PowerPoint {
131541
131533
  interface ShapeFontData {
131542
131534
  /**
131543
131535
  * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
131544
- *
131545
- * - `true`: All the text has the **All Caps** attribute.
131546
- *
131547
- * - `false`: None of the text has the **All Caps**attribute.
131548
- *
131549
- * - `null`: Some, but not all, of the text has the **All Caps** attribute.
131536
+
131537
+ - `true`: All the text has the **All Caps** attribute.
131538
+
131539
+ - `false`: None of the text has the **All Caps** attribute.
131540
+
131541
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
131550
131542
  *
131551
131543
  * @remarks
131552
131544
  * [Api set: PowerPointApi 1.8]
@@ -131554,12 +131546,12 @@ declare namespace PowerPoint {
131554
131546
  allCaps?: boolean | null;
131555
131547
  /**
131556
131548
  * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
131557
- *
131558
- * - `true`: All the text is bold.
131559
- *
131560
- * - `false`: None of the text is bold.
131561
- *
131562
- * - `null`: Returned if some, but not all, of the text is bold.
131549
+
131550
+ - `true`: All the text is bold.
131551
+
131552
+ - `false`: None of the text is bold.
131553
+
131554
+ - `null`: Returned if some, but not all, of the text is bold.
131563
131555
  *
131564
131556
  * @remarks
131565
131557
  * [Api set: PowerPointApi 1.4]
@@ -131574,12 +131566,12 @@ declare namespace PowerPoint {
131574
131566
  color?: string | null;
131575
131567
  /**
131576
131568
  * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
131577
- *
131578
- * - `true`: All the text has the **Double strikethrough** attribute.
131579
- *
131580
- * - `false`: None of the text has the **Double strikethrough** attribute.
131581
- *
131582
- * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
131569
+
131570
+ - `true`: All the text has the **Double strikethrough** attribute.
131571
+
131572
+ - `false`: None of the text has the **Double strikethrough** attribute.
131573
+
131574
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
131583
131575
  *
131584
131576
  * @remarks
131585
131577
  * [Api set: PowerPointApi 1.8]
@@ -131587,12 +131579,12 @@ declare namespace PowerPoint {
131587
131579
  doubleStrikethrough?: boolean | null;
131588
131580
  /**
131589
131581
  * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
131590
- *
131591
- * - `true`: All the text is italicized.
131592
- *
131593
- * - `false`: None of the text is italicized.
131594
- *
131595
- * - `null`: Returned if some, but not all, of the text is italicized.
131582
+
131583
+ - `true`: All the text is italicized.
131584
+
131585
+ - `false`: None of the text is italicized.
131586
+
131587
+ - `null`: Returned if some, but not all, of the text is italicized.
131596
131588
  *
131597
131589
  * @remarks
131598
131590
  * [Api set: PowerPointApi 1.4]
@@ -131614,12 +131606,12 @@ declare namespace PowerPoint {
131614
131606
  size?: number | null;
131615
131607
  /**
131616
131608
  * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
131617
- *
131618
- * - `true`: All the text has the **Small Caps** attribute.
131619
- *
131620
- * - `false`: None of the text has the **Small Caps** attribute.
131621
- *
131622
- * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
131609
+
131610
+ - `true`: All the text has the **Small Caps** attribute.
131611
+
131612
+ - `false`: None of the text has the **Small Caps** attribute.
131613
+
131614
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
131623
131615
  *
131624
131616
  * @remarks
131625
131617
  * [Api set: PowerPointApi 1.8]
@@ -131627,12 +131619,12 @@ declare namespace PowerPoint {
131627
131619
  smallCaps?: boolean | null;
131628
131620
  /**
131629
131621
  * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
131630
- *
131631
- * - `true`: All the text has the **Strikethrough** attribute.
131632
- *
131633
- * - `false`: None of the text has the **Strikethrough** attribute.
131634
- *
131635
- * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
131622
+
131623
+ - `true`: All the text has the **Strikethrough** attribute.
131624
+
131625
+ - `false`: None of the text has the **Strikethrough** attribute.
131626
+
131627
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
131636
131628
  *
131637
131629
  * @remarks
131638
131630
  * [Api set: PowerPointApi 1.8]
@@ -131640,12 +131632,12 @@ declare namespace PowerPoint {
131640
131632
  strikethrough?: boolean | null;
131641
131633
  /**
131642
131634
  * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
131643
- *
131644
- * - `true`: All the text has the **Subscript** attribute.
131645
- *
131646
- * - `false`: None of the text has the **Subscript** attribute.
131647
- *
131648
- * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
131635
+
131636
+ - `true`: All the text has the **Subscript** attribute.
131637
+
131638
+ - `false`: None of the text has the **Subscript** attribute.
131639
+
131640
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
131649
131641
  *
131650
131642
  * @remarks
131651
131643
  * [Api set: PowerPointApi 1.8]
@@ -131653,12 +131645,12 @@ declare namespace PowerPoint {
131653
131645
  subscript?: boolean | null;
131654
131646
  /**
131655
131647
  * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
131656
- *
131657
- * - `true`: All the text has the **Superscript** attribute.
131658
- *
131659
- * - `false`: None of the text has the **Superscript** attribute.
131660
- *
131661
- * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
131648
+
131649
+ - `true`: All the text has the **Superscript** attribute.
131650
+
131651
+ - `false`: None of the text has the **Superscript** attribute.
131652
+
131653
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
131662
131654
  *
131663
131655
  * @remarks
131664
131656
  * [Api set: PowerPointApi 1.8]
@@ -131904,7 +131896,7 @@ declare namespace PowerPoint {
131904
131896
  * @remarks
131905
131897
  * [Api set: PowerPointApi 1.4]
131906
131898
  */
131907
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
131899
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
131908
131900
  }
131909
131901
  /** An interface describing the data returned by calling `textRange.toJSON()`. */
131910
131902
  interface TextRangeData {
@@ -132436,12 +132428,12 @@ declare namespace PowerPoint {
132436
132428
  $all?: boolean;
132437
132429
  /**
132438
132430
  * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows:
132439
- *
132440
- * - `true`: All the text has the **All Caps** attribute.
132441
- *
132442
- * - `false`: None of the text has the **All Caps**attribute.
132443
- *
132444
- * - `null`: Some, but not all, of the text has the **All Caps** attribute.
132431
+
132432
+ - `true`: All the text has the **All Caps** attribute.
132433
+
132434
+ - `false`: None of the text has the **All Caps** attribute.
132435
+
132436
+ - `null`: Returned if some, but not all, of the text has the **All Caps** attribute.
132445
132437
  *
132446
132438
  * @remarks
132447
132439
  * [Api set: PowerPointApi 1.8]
@@ -132449,12 +132441,12 @@ declare namespace PowerPoint {
132449
132441
  allCaps?: boolean;
132450
132442
  /**
132451
132443
  * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
132452
- *
132453
- * - `true`: All the text is bold.
132454
- *
132455
- * - `false`: None of the text is bold.
132456
- *
132457
- * - `null`: Returned if some, but not all, of the text is bold.
132444
+
132445
+ - `true`: All the text is bold.
132446
+
132447
+ - `false`: None of the text is bold.
132448
+
132449
+ - `null`: Returned if some, but not all, of the text is bold.
132458
132450
  *
132459
132451
  * @remarks
132460
132452
  * [Api set: PowerPointApi 1.4]
@@ -132469,12 +132461,12 @@ declare namespace PowerPoint {
132469
132461
  color?: boolean;
132470
132462
  /**
132471
132463
  * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows:
132472
- *
132473
- * - `true`: All the text has the **Double strikethrough** attribute.
132474
- *
132475
- * - `false`: None of the text has the **Double strikethrough** attribute.
132476
- *
132477
- * - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
132464
+
132465
+ - `true`: All the text has the **Double strikethrough** attribute.
132466
+
132467
+ - `false`: None of the text has the **Double strikethrough** attribute.
132468
+
132469
+ - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute.
132478
132470
  *
132479
132471
  * @remarks
132480
132472
  * [Api set: PowerPointApi 1.8]
@@ -132482,12 +132474,12 @@ declare namespace PowerPoint {
132482
132474
  doubleStrikethrough?: boolean;
132483
132475
  /**
132484
132476
  * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
132485
- *
132486
- * - `true`: All the text is italicized.
132487
- *
132488
- * - `false`: None of the text is italicized.
132489
- *
132490
- * - `null`: Returned if some, but not all, of the text is italicized.
132477
+
132478
+ - `true`: All the text is italicized.
132479
+
132480
+ - `false`: None of the text is italicized.
132481
+
132482
+ - `null`: Returned if some, but not all, of the text is italicized.
132491
132483
  *
132492
132484
  * @remarks
132493
132485
  * [Api set: PowerPointApi 1.4]
@@ -132509,12 +132501,12 @@ declare namespace PowerPoint {
132509
132501
  size?: boolean;
132510
132502
  /**
132511
132503
  * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows:
132512
- *
132513
- * - `true`: All the text has the **Small Caps** attribute.
132514
- *
132515
- * - `false`: None of the text has the **Small Caps** attribute.
132516
- *
132517
- * - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
132504
+
132505
+ - `true`: All the text has the **Small Caps** attribute.
132506
+
132507
+ - `false`: None of the text has the **Small Caps** attribute.
132508
+
132509
+ - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute.
132518
132510
  *
132519
132511
  * @remarks
132520
132512
  * [Api set: PowerPointApi 1.8]
@@ -132522,12 +132514,12 @@ declare namespace PowerPoint {
132522
132514
  smallCaps?: boolean;
132523
132515
  /**
132524
132516
  * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows:
132525
- *
132526
- * - `true`: All the text has the **Strikethrough** attribute.
132527
- *
132528
- * - `false`: None of the text has the **Strikethrough** attribute.
132529
- *
132530
- * - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
132517
+
132518
+ - `true`: All the text has the **Strikethrough** attribute.
132519
+
132520
+ - `false`: None of the text has the **Strikethrough** attribute.
132521
+
132522
+ - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute.
132531
132523
  *
132532
132524
  * @remarks
132533
132525
  * [Api set: PowerPointApi 1.8]
@@ -132535,12 +132527,12 @@ declare namespace PowerPoint {
132535
132527
  strikethrough?: boolean;
132536
132528
  /**
132537
132529
  * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows:
132538
- *
132539
- * - `true`: All the text has the **Subscript** attribute.
132540
- *
132541
- * - `false`: None of the text has the **Subscript** attribute.
132542
- *
132543
- * - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
132530
+
132531
+ - `true`: All the text has the **Subscript** attribute.
132532
+
132533
+ - `false`: None of the text has the **Subscript** attribute.
132534
+
132535
+ - `null`: Returned if some, but not all, of the text has the **Subscript** attribute.
132544
132536
  *
132545
132537
  * @remarks
132546
132538
  * [Api set: PowerPointApi 1.8]
@@ -132548,12 +132540,12 @@ declare namespace PowerPoint {
132548
132540
  subscript?: boolean;
132549
132541
  /**
132550
132542
  * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
132551
- *
132552
- * - `true`: All the text has the **Superscript** attribute.
132553
- *
132554
- * - `false`: None of the text has the **Superscript** attribute.
132555
- *
132556
- * - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
132543
+
132544
+ - `true`: All the text has the **Superscript** attribute.
132545
+
132546
+ - `false`: None of the text has the **Superscript** attribute.
132547
+
132548
+ - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
132557
132549
  *
132558
132550
  * @remarks
132559
132551
  * [Api set: PowerPointApi 1.8]
@@ -133858,7 +133850,7 @@ declare namespace PowerPoint {
133858
133850
  }
133859
133851
  declare namespace PowerPoint {
133860
133852
  /**
133861
- * Creates and opens a new presentation. Optionally, the presentation can be pre-populated with a Base64-encoded .pptx file.
133853
+ * Creates and opens a new presentation. Optionally, the presentation can be prepopulated with a Base64-encoded .pptx file.
133862
133854
  *
133863
133855
  * [Api set: PowerPointApi 1.1]
133864
133856
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.497",
3
+ "version": "1.0.499",
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",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "80fce7fc13f62e7330538f0add5924fbff148f54a75a25cc4c287a725966866e",
49
+ "typesPublisherContentHash": "4914792c64536b556a3a9457b4874a990fb21ad07b38ff87f9fcada162023810",
50
50
  "typeScriptVersion": "5.1"
51
51
  }