@types/office-js 1.0.243 → 1.0.246

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.
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: Tue, 29 Mar 2022 16:31:49 GMT
11
+ * Last updated: Thu, 07 Apr 2022 21:31:17 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
office-js/index.d.ts CHANGED
@@ -411,6 +411,9 @@ declare namespace Office {
411
411
  }
412
412
  /**
413
413
  * Specifies the host Office application in which the add-in is running.
414
+ *
415
+ * @remarks
416
+ * **Important**: In Outlook, this enum is available from Mailbox requirement set 1.5.
414
417
  */
415
418
  enum HostType {
416
419
  /**
@@ -448,6 +451,9 @@ declare namespace Office {
448
451
  }
449
452
  /**
450
453
  * Specifies the OS or other platform on which the Office host application is running.
454
+ *
455
+ * @remarks
456
+ * **Important**: In Outlook, this enum is available from Mailbox requirement set 1.5.
451
457
  */
452
458
  enum PlatformType {
453
459
  /**
@@ -463,7 +469,7 @@ declare namespace Office {
463
469
  */
464
470
  Mac,
465
471
  /**
466
- * The platform an iOS device.
472
+ * The platform is an iOS device.
467
473
  */
468
474
  iOS,
469
475
  /**
@@ -785,6 +791,12 @@ declare namespace Office {
785
791
  contentLanguage: string;
786
792
  /**
787
793
  * Gets information about the environment in which the add-in is running.
794
+ *
795
+ * @remarks
796
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5.
797
+ * For all Mailbox requirement sets, you can use the
798
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
799
+ * property to get similar information.
788
800
  */
789
801
  diagnostics: ContextInformation;
790
802
  /**
@@ -825,8 +837,12 @@ declare namespace Office {
825
837
  /**
826
838
  * Contains the Office application host in which the add-in is running.
827
839
  *
828
- * **Important**: In Outlook, this property is available from requirement set 1.5.
829
- * For all Mailbox requirement sets, you can use the `Office.context.diagnostics` property to get the host.
840
+ * @remarks
841
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
842
+ * `Office.context.diagnostics` property to get the host starting with requirement set 1.5. For all
843
+ * Mailbox requirement sets, you can use the
844
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
845
+ * property to get similar information.
830
846
  */
831
847
  host: HostType;
832
848
  /**
@@ -858,8 +874,12 @@ declare namespace Office {
858
874
  /**
859
875
  * Provides the platform on which the add-in is running.
860
876
  *
861
- * **Important**: In Outlook, this property is available from requirement set 1.5.
862
- * For all Mailbox requirement sets, you can use the `Office.context.diagnostics` property to get the platform.
877
+ * @remarks
878
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
879
+ * `Office.context.diagnostics` property to get the platform starting with requirement set 1.5. For all
880
+ * Mailbox requirement sets, you can use the
881
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
882
+ * property to get similar information.
863
883
  */
864
884
  platform: PlatformType;
865
885
  /**
@@ -1472,6 +1492,12 @@ declare namespace Office {
1472
1492
  }
1473
1493
  /**
1474
1494
  * Provides information about the environment in which the add-in is running.
1495
+ *
1496
+ * @remarks
1497
+ * **Important**: In Outlook, this object is available from Mailbox requirement set 1.5.
1498
+ * For all Mailbox requirement sets, you can use the
1499
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
1500
+ * property to get similar information.
1475
1501
  */
1476
1502
  interface ContextInformation {
1477
1503
  /**
@@ -9390,7 +9416,7 @@ declare namespace Office {
9390
9416
  *
9391
9417
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
9392
9418
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
9393
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
9419
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
9394
9420
  *
9395
9421
  * Child interfaces:
9396
9422
  *
@@ -9405,7 +9431,7 @@ declare namespace Office {
9405
9431
  *
9406
9432
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
9407
9433
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
9408
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
9434
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
9409
9435
  *
9410
9436
  * Parent interfaces:
9411
9437
  *
@@ -9780,7 +9806,7 @@ declare namespace Office {
9780
9806
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
9781
9807
  *
9782
9808
  * For supported events, refer to the Item object model
9783
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
9809
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
9784
9810
  *
9785
9811
  * @remarks
9786
9812
  * [Api set: Mailbox 1.7]
@@ -9802,7 +9828,7 @@ declare namespace Office {
9802
9828
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
9803
9829
  *
9804
9830
  * For supported events, refer to the Item object model
9805
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
9831
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
9806
9832
  *
9807
9833
  * @remarks
9808
9834
  * [Api set: Mailbox 1.7]
@@ -10304,7 +10330,7 @@ declare namespace Office {
10304
10330
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
10305
10331
  *
10306
10332
  * For supported events, refer to the Item object model
10307
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
10333
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
10308
10334
  *
10309
10335
  * @remarks
10310
10336
  * [Api set: Mailbox 1.7]
@@ -10324,7 +10350,7 @@ declare namespace Office {
10324
10350
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
10325
10351
  *
10326
10352
  * For supported events, refer to the Item object model
10327
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
10353
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
10328
10354
  *
10329
10355
  * @remarks
10330
10356
  * [Api set: Mailbox 1.7]
@@ -10649,7 +10675,7 @@ declare namespace Office {
10649
10675
  *
10650
10676
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
10651
10677
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
10652
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
10678
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
10653
10679
  *
10654
10680
  * Parent interfaces:
10655
10681
  *
@@ -10969,7 +10995,7 @@ declare namespace Office {
10969
10995
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
10970
10996
  *
10971
10997
  * For supported events, refer to the Item object model
10972
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
10998
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
10973
10999
  *
10974
11000
  * @remarks
10975
11001
  * [Api set: Mailbox 1.7]
@@ -10991,7 +11017,7 @@ declare namespace Office {
10991
11017
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
10992
11018
  *
10993
11019
  * For supported events, refer to the Item object model
10994
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
11020
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
10995
11021
  *
10996
11022
  * @remarks
10997
11023
  * [Api set: Mailbox 1.7]
@@ -11480,7 +11506,7 @@ declare namespace Office {
11480
11506
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
11481
11507
  *
11482
11508
  * For supported events, refer to the Item object model
11483
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
11509
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
11484
11510
  *
11485
11511
  * @remarks
11486
11512
  * [Api set: Mailbox 1.7]
@@ -11500,7 +11526,7 @@ declare namespace Office {
11500
11526
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
11501
11527
  *
11502
11528
  * For supported events, refer to the Item object model
11503
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
11529
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
11504
11530
  *
11505
11531
  * @remarks
11506
11532
  * [Api set: Mailbox 1.7]
@@ -12455,6 +12481,10 @@ declare namespace Office {
12455
12481
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
12456
12482
  *
12457
12483
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12484
+ *
12485
+ * Starting with Mailbox requirement set 1.5, you can also use the
12486
+ * {@link https://docs.microsoft.com/javascript/api/office/office.context?view=outlook-js-1.5&preserve-view=true#office-office-context-diagnostics-member | Office.context.diagnostics}
12487
+ * property to get similar information.
12458
12488
  */
12459
12489
  interface Diagnostics {
12460
12490
  /**
@@ -13009,7 +13039,7 @@ declare namespace Office {
13009
13039
  * You can determine the type of the item by using the `itemType` property.
13010
13040
  *
13011
13041
  * To see the full member list, refer to the
13012
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
13042
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
13013
13043
  *
13014
13044
  * If you want to see IntelliSense for only a specific type or mode, cast this item to one of the following:
13015
13045
  *
@@ -13034,7 +13064,7 @@ declare namespace Office {
13034
13064
  *
13035
13065
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
13036
13066
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
13037
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
13067
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
13038
13068
  *
13039
13069
  * Child interfaces:
13040
13070
  *
@@ -13049,7 +13079,7 @@ declare namespace Office {
13049
13079
  *
13050
13080
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
13051
13081
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
13052
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
13082
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
13053
13083
  *
13054
13084
  * Child interfaces:
13055
13085
  *
@@ -13281,13 +13311,17 @@ declare namespace Office {
13281
13311
  * and `ThreeColumns` - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns
13282
13312
  * that can be displayed.
13283
13313
  *
13284
- * More information is under {@link Office.Diagnostics}.
13314
+ * More information is under {@link Office.Diagnostics}.
13285
13315
  *
13286
13316
  * @remarks
13287
13317
  *
13288
13318
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
13289
13319
  *
13290
13320
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
13321
+ *
13322
+ * Starting with Mailbox requirement set 1.5, you can also use the
13323
+ * {@link https://docs.microsoft.com/javascript/api/office/office.context?view=outlook-js-1.5&preserve-view=true#office-office-context-diagnostics-member | Office.context.diagnostics}
13324
+ * property to get similar information.
13291
13325
  */
13292
13326
  diagnostics: Diagnostics;
13293
13327
  /**
@@ -13366,7 +13400,7 @@ declare namespace Office {
13366
13400
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
13367
13401
  *
13368
13402
  * For supported events, refer to the Mailbox object model
13369
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox#events | events section}.
13403
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
13370
13404
  *
13371
13405
  * @remarks
13372
13406
  * [Api set: Mailbox 1.5]
@@ -13387,7 +13421,7 @@ declare namespace Office {
13387
13421
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
13388
13422
  *
13389
13423
  * For supported events, refer to the Mailbox object model
13390
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox#events | events section}.
13424
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
13391
13425
  *
13392
13426
  * @remarks
13393
13427
  * [Api set: Mailbox 1.5]
@@ -14090,7 +14124,7 @@ declare namespace Office {
14090
14124
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
14091
14125
  *
14092
14126
  * For supported events, refer to the Mailbox object model
14093
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox#events | events section}.
14127
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
14094
14128
  *
14095
14129
  * @remarks
14096
14130
  * [Api set: Mailbox 1.5]
@@ -14109,7 +14143,7 @@ declare namespace Office {
14109
14143
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
14110
14144
  *
14111
14145
  * For supported events, refer to the Mailbox object model
14112
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox#events | events section}.
14146
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox#events | events section}.
14113
14147
  *
14114
14148
  * @remarks
14115
14149
  * [Api set: Mailbox 1.5]
@@ -14301,7 +14335,7 @@ declare namespace Office {
14301
14335
  *
14302
14336
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
14303
14337
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
14304
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
14338
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
14305
14339
  *
14306
14340
  * Child interfaces:
14307
14341
  *
@@ -14316,7 +14350,7 @@ declare namespace Office {
14316
14350
  *
14317
14351
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
14318
14352
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
14319
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
14353
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
14320
14354
  *
14321
14355
  * Parent interfaces:
14322
14356
  *
@@ -14658,7 +14692,7 @@ declare namespace Office {
14658
14692
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
14659
14693
  *
14660
14694
  * For supported events, refer to the Item object model
14661
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
14695
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
14662
14696
  *
14663
14697
  * @remarks
14664
14698
  * [Api set: Mailbox 1.7]
@@ -14680,7 +14714,7 @@ declare namespace Office {
14680
14714
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
14681
14715
  *
14682
14716
  * For supported events, refer to the Item object model
14683
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
14717
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
14684
14718
  *
14685
14719
  * @remarks
14686
14720
  * [Api set: Mailbox 1.7]
@@ -15240,7 +15274,7 @@ declare namespace Office {
15240
15274
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
15241
15275
  *
15242
15276
  * For supported events, refer to the Item object model
15243
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
15277
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
15244
15278
  *
15245
15279
  * @remarks
15246
15280
  * [Api set: Mailbox 1.7]
@@ -15260,7 +15294,7 @@ declare namespace Office {
15260
15294
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
15261
15295
  *
15262
15296
  * For supported events, refer to the Item object model
15263
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
15297
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
15264
15298
  *
15265
15299
  * @remarks
15266
15300
  * [Api set: Mailbox 1.7]
@@ -15404,7 +15438,7 @@ declare namespace Office {
15404
15438
  *
15405
15439
  * **Important**: This is an internal Outlook object, not directly exposed through existing interfaces.
15406
15440
  * You should treat this as a mode of `Office.context.mailbox.item`. For more information, refer to the
15407
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item | Object Model} page.
15441
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item | Object Model} page.
15408
15442
  *
15409
15443
  * Parent interfaces:
15410
15444
  *
@@ -15775,7 +15809,7 @@ declare namespace Office {
15775
15809
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
15776
15810
  *
15777
15811
  * For supported events, refer to the Item object model
15778
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
15812
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
15779
15813
  *
15780
15814
  * @remarks
15781
15815
  * [Api set: Mailbox 1.7]
@@ -15797,7 +15831,7 @@ declare namespace Office {
15797
15831
  * Adds an event handler for a supported event. **Note**: Events are only available with task pane implementation.
15798
15832
  *
15799
15833
  * For supported events, refer to the Item object model
15800
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
15834
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
15801
15835
  *
15802
15836
  * @remarks
15803
15837
  * [Api set: Mailbox 1.7]
@@ -16326,7 +16360,7 @@ declare namespace Office {
16326
16360
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
16327
16361
  *
16328
16362
  * For supported events, refer to the Item object model
16329
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
16363
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
16330
16364
  *
16331
16365
  * @remarks
16332
16366
  * [Api set: Mailbox 1.7]
@@ -16346,7 +16380,7 @@ declare namespace Office {
16346
16380
  * Removes the event handlers for a supported event type. **Note**: Events are only available with task pane implementation.
16347
16381
  *
16348
16382
  * For supported events, refer to the Item object model
16349
- * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.10/office.context.mailbox.item#events | events section}.
16383
+ * {@link https://docs.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.11/office.context.mailbox.item#events | events section}.
16350
16384
  *
16351
16385
  * @remarks
16352
16386
  * [Api set: Mailbox 1.7]
@@ -22715,7 +22749,7 @@ declare namespace Excel {
22715
22749
  * @remarks
22716
22750
  * [Api set: ExcelApi 1.9]
22717
22751
  *
22718
- * @param address Optional. A string containing the comma-separated addresses or names of the individual ranges. For example, "A1:B2, A5:B5". If not specified, an RangeArea object for the entire worksheet is returned.
22752
+ * @param address Optional. A string containing the comma-separated or semicolon-separated addresses or names of the individual ranges. For example, "A1:B2, A5:B5" or "A1:B2; A5:B5". If not specified, a `RangeAreas` object for the entire worksheet is returned.
22719
22753
  */
22720
22754
  getRanges(address?: string): Excel.RangeAreas;
22721
22755
  /**
@@ -23092,7 +23126,7 @@ declare namespace Excel {
23092
23126
  */
23093
23127
  readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;
23094
23128
  /**
23095
- * Occurs when a worksheet is moved by a user within a workbook.
23129
+ * Occurs when a worksheet is moved within a workbook. This event only triggers when a worksheet is directly moved within a workbook. This event doesn't trigger when the position of a worksheet is indirectly changed, such as when a new worksheet is inserted and causes existing worksheets to change positions.
23096
23130
  *
23097
23131
  * @remarks
23098
23132
  * [Api set: ExcelApiOnline 1.1]
@@ -23172,7 +23206,7 @@ declare namespace Excel {
23172
23206
  toJSON(): Excel.Interfaces.WorksheetCollectionData;
23173
23207
  }
23174
23208
  /**
23175
- * Represents the protection of a sheet object.
23209
+ * Represents the protection of a worksheet object.
23176
23210
  *
23177
23211
  * @remarks
23178
23212
  * [Api set: ExcelApi 1.2]
@@ -23716,11 +23750,11 @@ declare namespace Excel {
23716
23750
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
23717
23751
  set(properties: Excel.Range): void;
23718
23752
  /**
23719
- * Fills range from the current range to the destination range using the specified AutoFill logic.
23720
- The destination range can be `null`, or can extend the source either horizontally or vertically.
23721
- Discontiguous ranges are not supported.
23753
+ * Fills a range from the current range to the destination range using the specified AutoFill logic.
23754
+ The destination range can be `null` or can extend the source range either horizontally or vertically.
23755
+ Discontiguous ranges are not supported.
23722
23756
 
23723
- For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
23757
+ For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
23724
23758
  *
23725
23759
  * @remarks
23726
23760
  * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
@@ -23730,11 +23764,11 @@ declare namespace Excel {
23730
23764
  */
23731
23765
  autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;
23732
23766
  /**
23733
- * Fills range from the current range to the destination range using the specified AutoFill logic.
23734
- The destination range can be `null`, or can extend the source either horizontally or vertically.
23735
- Discontiguous ranges are not supported.
23767
+ * Fills a range from the current range to the destination range using the specified AutoFill logic.
23768
+ The destination range can be `null` or can extend the source range either horizontally or vertically.
23769
+ Discontiguous ranges are not supported.
23736
23770
 
23737
- For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
23771
+ For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
23738
23772
  *
23739
23773
  * @remarks
23740
23774
  * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
@@ -24035,7 +24069,8 @@ declare namespace Excel {
24035
24069
  */
24036
24070
  getLastRow(): Excel.Range;
24037
24071
  /**
24038
- * Returns a RangeAreas object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, the API will fail to return the result. If the RangeAreas does not exist, will return a null object.
24072
+ * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
24073
+ For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
24039
24074
  *
24040
24075
  * @remarks
24041
24076
  * [Api set: ExcelApi 1.13]
@@ -26531,7 +26566,7 @@ declare namespace Excel {
26531
26566
  /**
26532
26567
  * Name of the table.
26533
26568
 
26534
- The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
26569
+ The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
26535
26570
  *
26536
26571
  * @remarks
26537
26572
  * [Api set: ExcelApi 1.1]
@@ -33134,7 +33169,7 @@ declare namespace Excel {
33134
33169
  */
33135
33170
  getRangeOrNullObject(): Excel.Range;
33136
33171
  /**
33137
- * Applies the specified Autofilter object currently on the range.
33172
+ * Applies the specified AutoFilter object currently on the range.
33138
33173
  *
33139
33174
  * @remarks
33140
33175
  * [Api set: ExcelApi 1.9]
@@ -39916,7 +39951,7 @@ declare namespace Excel {
39916
39951
  * @remarks
39917
39952
  * [Api set: ExcelApi 1.9]
39918
39953
  *
39919
- * @param key Name or ID of the shape to be retrieved.
39954
+ * @param key The name or ID of the shape to be retrieved.
39920
39955
  */
39921
39956
  getItem(key: string): Excel.Shape;
39922
39957
  /**
@@ -52928,7 +52963,7 @@ declare namespace Excel {
52928
52963
  /**
52929
52964
  * Name of the table.
52930
52965
 
52931
- The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
52966
+ The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
52932
52967
  *
52933
52968
  * @remarks
52934
52969
  * [Api set: ExcelApi 1.1]
@@ -58467,7 +58502,7 @@ declare namespace Excel {
58467
58502
  /**
58468
58503
  * Name of the table.
58469
58504
 
58470
- The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
58505
+ The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
58471
58506
  *
58472
58507
  * @remarks
58473
58508
  * [Api set: ExcelApi 1.1]
@@ -64398,7 +64433,7 @@ declare namespace Excel {
64398
64433
  visibility?: boolean;
64399
64434
  }
64400
64435
  /**
64401
- * Represents the protection of a sheet object.
64436
+ * Represents the protection of a worksheet object.
64402
64437
  *
64403
64438
  * @remarks
64404
64439
  * [Api set: ExcelApi 1.2]
@@ -65331,7 +65366,7 @@ declare namespace Excel {
65331
65366
  /**
65332
65367
  * For EACH ITEM in the collection: Name of the table.
65333
65368
 
65334
- The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
65369
+ The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
65335
65370
  *
65336
65371
  * @remarks
65337
65372
  * [Api set: ExcelApi 1.1]
@@ -65457,7 +65492,7 @@ declare namespace Excel {
65457
65492
  /**
65458
65493
  * For EACH ITEM in the collection: Name of the table.
65459
65494
 
65460
- The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
65495
+ The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
65461
65496
  *
65462
65497
  * @remarks
65463
65498
  * [Api set: ExcelApi 1.1]
@@ -65584,7 +65619,7 @@ declare namespace Excel {
65584
65619
  /**
65585
65620
  * Name of the table.
65586
65621
 
65587
- The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
65622
+ The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
65588
65623
  *
65589
65624
  * @remarks
65590
65625
  * [Api set: ExcelApi 1.1]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.243",
3
+ "version": "1.0.246",
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": "f3aab093bd595648bb31c8f4f9c8a037bc1ab9c1f7855164f6d0e048e7a7892f",
48
+ "typesPublisherContentHash": "ed4f0a259654d5ea6da54c8d7bf96b6c1dcb1f7b3579dbcf671aefb8b4b3f478",
49
49
  "typeScriptVersion": "3.9"
50
50
  }