@types/office-js 1.0.526 → 1.0.528
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 +1 -1
- office-js/index.d.ts +83 -75
- 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:
|
|
11
|
+
* Last updated: Wed, 27 Aug 2025 16:02:42 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -7203,7 +7203,7 @@ declare namespace Office {
|
|
|
7203
7203
|
* <td><strong>Outlook</strong></td>
|
|
7204
7204
|
* <td>Supported</td>
|
|
7205
7205
|
* <td>Supported</td>
|
|
7206
|
-
* <td>
|
|
7206
|
+
* <td>Supported</td>
|
|
7207
7207
|
* <td>Not available</td>
|
|
7208
7208
|
* <td>Not available</td>
|
|
7209
7209
|
* </tr>
|
|
@@ -8811,7 +8811,7 @@ declare namespace Office {
|
|
|
8811
8811
|
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | Activate add-ins with events} and
|
|
8812
8812
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | Implement an integrated spam-reporting add-in}.
|
|
8813
8813
|
*
|
|
8814
|
-
* - In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
8814
|
+
* - In Outlook on the web, on Mac, and in the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
8815
8815
|
* this API isn't supported in add-ins that implement a task pane. On these clients, the API is only supported in add-ins that implement event-based activation
|
|
8816
8816
|
* or integrated spam reporting.
|
|
8817
8817
|
*
|
|
@@ -18834,7 +18834,7 @@ declare namespace Office {
|
|
|
18834
18834
|
*/
|
|
18835
18835
|
from: From;
|
|
18836
18836
|
/**
|
|
18837
|
-
* Gets the message ID of the original message being replied to by the current message.
|
|
18837
|
+
* Gets the internet message ID of the original message being replied to by the current message.
|
|
18838
18838
|
*
|
|
18839
18839
|
* @remarks
|
|
18840
18840
|
* [Api set: Mailbox 1.14]
|
|
@@ -19314,10 +19314,14 @@ declare namespace Office {
|
|
|
19314
19314
|
*
|
|
19315
19315
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19316
19316
|
*
|
|
19317
|
-
* **Important**:
|
|
19317
|
+
* **Important**:
|
|
19318
|
+
*
|
|
19319
|
+
* - The `closeAsync` method is only supported in task pane and function command implementations. It isn't supported in
|
|
19318
19320
|
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
|
|
19319
19321
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
|
|
19320
19322
|
*
|
|
19323
|
+
* - When the `closeAsync` method successfully closes and discards the current message, the add-in that called it ceases running.
|
|
19324
|
+
*
|
|
19321
19325
|
* **Errors**:
|
|
19322
19326
|
*
|
|
19323
19327
|
* - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog and the `discardItem` property isn't defined or is set to `false`.
|
|
@@ -19350,10 +19354,14 @@ declare namespace Office {
|
|
|
19350
19354
|
*
|
|
19351
19355
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19352
19356
|
*
|
|
19353
|
-
* **Important**:
|
|
19357
|
+
* **Important**:
|
|
19358
|
+
*
|
|
19359
|
+
* - The `closeAsync` method is only supported in task pane and function command implementations. It isn't supported in
|
|
19354
19360
|
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based handlers} or
|
|
19355
19361
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | item multi-select scenarios}.
|
|
19356
19362
|
*
|
|
19363
|
+
* - When the `closeAsync` method successfully closes and discards the current message, the add-in that called it ceases running.
|
|
19364
|
+
*
|
|
19357
19365
|
* **Errors**:
|
|
19358
19366
|
*
|
|
19359
19367
|
* - `The operation was cancelled by the user`: The user selects **Cancel** from the save dialog.
|
|
@@ -23594,7 +23602,7 @@ declare namespace Office {
|
|
|
23594
23602
|
*
|
|
23595
23603
|
* - In earlier supported versions of classic Outlook on Windows (versions prior to Version 2412 (Build 18324.20000) that support
|
|
23596
23604
|
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets#version-support-for-requirement-sets-in-classic-outlook-on-windows | Mailbox requirement set 1.14}),
|
|
23597
|
-
* and Outlook on Mac
|
|
23605
|
+
* and Outlook on Mac, the `cancelLabel` property customizes the text of the **Don't Send** button. The **Don't Send** button cancels the item being sent.
|
|
23598
23606
|
*/
|
|
23599
23607
|
cancelLabel?: string;
|
|
23600
23608
|
/**
|
|
@@ -23606,7 +23614,7 @@ declare namespace Office {
|
|
|
23606
23614
|
*
|
|
23607
23615
|
* @remarks
|
|
23608
23616
|
*
|
|
23609
|
-
* [Api set: Mailbox 1.14]
|
|
23617
|
+
* [Api set: Mailbox 1.14 (task pane support), Mailbox 1.15 (function command support)]
|
|
23610
23618
|
*
|
|
23611
23619
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
23612
23620
|
*
|
|
@@ -23626,7 +23634,7 @@ declare namespace Office {
|
|
|
23626
23634
|
* task pane or runs a function. In this implementation, the **Don't Send** button cancels the item being sent. Its text and functionality can't be customized.
|
|
23627
23635
|
* In earlier supported versions of classic Outlook on Windows (versions prior to Version 2412 (Build 18324.20000) that support
|
|
23628
23636
|
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets#version-support-for-requirement-sets-in-classic-outlook-on-windows | Mailbox requirement set 1.14}),
|
|
23629
|
-
* and Outlook on Mac
|
|
23637
|
+
* and Outlook on Mac, the **Don't Send** button opens a task pane or runs a function.
|
|
23630
23638
|
*
|
|
23631
23639
|
* If you customized the text and functionality of the **Don't Send** button in your Smart Alerts add-in prior to Version 2412 (Build 18324.20000) of classic Outlook on Windows,
|
|
23632
23640
|
* no additional action is needed to implement the **Take Action** button in the latest supported versions. The default or customized **Take Action** button will automatically appear the next time a user receives a Smart Alerts dialog.
|
|
@@ -130210,9 +130218,9 @@ declare namespace PowerPoint {
|
|
|
130210
130218
|
expand?: string;
|
|
130211
130219
|
}): PowerPoint.TableCell;
|
|
130212
130220
|
/**
|
|
130213
|
-
|
|
130214
|
-
|
|
130215
|
-
|
|
130221
|
+
* Overrides the JavaScript `toJSON()` method in order to provide 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.)
|
|
130222
|
+
* Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
|
|
130223
|
+
*/
|
|
130216
130224
|
toJSON(): PowerPoint.Interfaces.TableCellData;
|
|
130217
130225
|
}
|
|
130218
130226
|
/**
|
|
@@ -130264,9 +130272,9 @@ declare namespace PowerPoint {
|
|
|
130264
130272
|
*/
|
|
130265
130273
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection;
|
|
130266
130274
|
/**
|
|
130267
|
-
|
|
130268
|
-
|
|
130269
|
-
|
|
130275
|
+
* Overrides the JavaScript `toJSON()` method in order to provide 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.)
|
|
130276
|
+
* Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
130277
|
+
*/
|
|
130270
130278
|
toJSON(): PowerPoint.Interfaces.TableCellCollectionData;
|
|
130271
130279
|
}
|
|
130272
130280
|
/**
|
|
@@ -130472,7 +130480,7 @@ declare namespace PowerPoint {
|
|
|
130472
130480
|
*/
|
|
130473
130481
|
text?: string;
|
|
130474
130482
|
/**
|
|
130475
|
-
* Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
130483
|
+
* Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
|
|
130476
130484
|
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
130477
130485
|
*
|
|
130478
130486
|
* @remarks
|
|
@@ -130565,9 +130573,9 @@ declare namespace PowerPoint {
|
|
|
130565
130573
|
expand?: string;
|
|
130566
130574
|
}): PowerPoint.Table;
|
|
130567
130575
|
/**
|
|
130568
|
-
|
|
130569
|
-
|
|
130570
|
-
|
|
130576
|
+
* Overrides the JavaScript `toJSON()` method in order to provide 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.)
|
|
130577
|
+
* Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
|
|
130578
|
+
*/
|
|
130571
130579
|
toJSON(): PowerPoint.Interfaces.TableData;
|
|
130572
130580
|
}
|
|
130573
130581
|
/**
|
|
@@ -130832,8 +130840,8 @@ declare namespace PowerPoint {
|
|
|
130832
130840
|
* @param options Provides options describing the new table.
|
|
130833
130841
|
* @returns The newly inserted shape.
|
|
130834
130842
|
*/
|
|
130835
|
-
|
|
130836
|
-
|
|
130843
|
+
addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): PowerPoint.Shape;
|
|
130844
|
+
/**
|
|
130837
130845
|
* Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box.
|
|
130838
130846
|
*
|
|
130839
130847
|
* @remarks
|
|
@@ -133927,7 +133935,7 @@ declare namespace PowerPoint {
|
|
|
133927
133935
|
* [Api set: PowerPointApi 1.8]
|
|
133928
133936
|
*/
|
|
133929
133937
|
allCaps?: boolean | null;
|
|
133930
|
-
|
|
133938
|
+
/**
|
|
133931
133939
|
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
133932
133940
|
|
|
133933
133941
|
- `true`: All the text is bold.
|
|
@@ -135403,12 +135411,12 @@ declare namespace PowerPoint {
|
|
|
135403
135411
|
*/
|
|
135404
135412
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
135405
135413
|
/**
|
|
135406
|
-
|
|
135414
|
+
* For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
|
|
135407
135415
|
If the shape type isn't `group`, then this method returns the `GeneralException` error.
|
|
135408
|
-
|
|
135409
|
-
|
|
135410
|
-
|
|
135411
|
-
|
|
135416
|
+
*
|
|
135417
|
+
* @remarks
|
|
135418
|
+
* [Api set: PowerPointApi 1.8]
|
|
135419
|
+
*/
|
|
135412
135420
|
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
|
|
135413
135421
|
/**
|
|
135414
135422
|
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
@@ -135418,23 +135426,23 @@ declare namespace PowerPoint {
|
|
|
135418
135426
|
*/
|
|
135419
135427
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
135420
135428
|
/**
|
|
135421
|
-
|
|
135429
|
+
* For EACH ITEM in the collection: Returns the parent group of this shape.
|
|
135422
135430
|
If the shape isn't part of a group, then this method returns the `GeneralException` error.
|
|
135423
|
-
|
|
135424
|
-
|
|
135425
|
-
|
|
135426
|
-
|
|
135431
|
+
*
|
|
135432
|
+
* @remarks
|
|
135433
|
+
* [Api set: PowerPointApi 1.8]
|
|
135434
|
+
*/
|
|
135427
135435
|
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
135428
135436
|
/**
|
|
135429
|
-
|
|
135437
|
+
* For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder.
|
|
135430
135438
|
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
|
|
135431
|
-
|
|
135432
|
-
|
|
135433
|
-
|
|
135434
|
-
|
|
135439
|
+
*
|
|
135440
|
+
* @remarks
|
|
135441
|
+
* [Api set: PowerPointApi 1.8]
|
|
135442
|
+
*/
|
|
135435
135443
|
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
135436
135444
|
/**
|
|
135437
|
-
|
|
135445
|
+
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
|
|
135438
135446
|
*
|
|
135439
135447
|
* @remarks
|
|
135440
135448
|
* [Api set: PowerPointApi 1.5]
|
|
@@ -135779,12 +135787,12 @@ declare namespace PowerPoint {
|
|
|
135779
135787
|
*/
|
|
135780
135788
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
135781
135789
|
/**
|
|
135782
|
-
|
|
135790
|
+
* Returns the `ShapeGroup` associated with the shape.
|
|
135783
135791
|
If the shape type isn't `group`, then this method returns the `GeneralException` error.
|
|
135784
|
-
|
|
135785
|
-
|
|
135786
|
-
|
|
135787
|
-
|
|
135792
|
+
*
|
|
135793
|
+
* @remarks
|
|
135794
|
+
* [Api set: PowerPointApi 1.8]
|
|
135795
|
+
*/
|
|
135788
135796
|
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
|
|
135789
135797
|
/**
|
|
135790
135798
|
* Returns the line formatting of this shape.
|
|
@@ -135794,23 +135802,23 @@ declare namespace PowerPoint {
|
|
|
135794
135802
|
*/
|
|
135795
135803
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
135796
135804
|
/**
|
|
135797
|
-
|
|
135805
|
+
* Returns the parent group of this shape.
|
|
135798
135806
|
If the shape isn't part of a group, then this method returns the `GeneralException` error.
|
|
135799
|
-
|
|
135800
|
-
|
|
135801
|
-
|
|
135802
|
-
|
|
135807
|
+
*
|
|
135808
|
+
* @remarks
|
|
135809
|
+
* [Api set: PowerPointApi 1.8]
|
|
135810
|
+
*/
|
|
135803
135811
|
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
|
|
135804
135812
|
/**
|
|
135805
|
-
|
|
135813
|
+
* Returns the properties that apply specifically to this placeholder.
|
|
135806
135814
|
If the shape type isn't `placeholder`, then this method returns the `GeneralException` error.
|
|
135807
|
-
|
|
135808
|
-
|
|
135809
|
-
|
|
135810
|
-
|
|
135815
|
+
*
|
|
135816
|
+
* @remarks
|
|
135817
|
+
* [Api set: PowerPointApi 1.8]
|
|
135818
|
+
*/
|
|
135811
135819
|
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
135812
135820
|
/**
|
|
135813
|
-
|
|
135821
|
+
* Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
|
|
135814
135822
|
*
|
|
135815
135823
|
* @remarks
|
|
135816
135824
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -135849,8 +135857,8 @@ declare namespace PowerPoint {
|
|
|
135849
135857
|
* @remarks
|
|
135850
135858
|
* [Api set: PowerPointApi 1.8]
|
|
135851
135859
|
*/
|
|
135852
|
-
|
|
135853
|
-
|
|
135860
|
+
level?: boolean;
|
|
135861
|
+
/**
|
|
135854
135862
|
* Specifies the name of this shape.
|
|
135855
135863
|
*
|
|
135856
135864
|
* @remarks
|
|
@@ -136108,18 +136116,18 @@ declare namespace PowerPoint {
|
|
|
136108
136116
|
*/
|
|
136109
136117
|
$all?: boolean;
|
|
136110
136118
|
/**
|
|
136111
|
-
|
|
136112
|
-
|
|
136113
|
-
|
|
136114
|
-
|
|
136115
|
-
|
|
136119
|
+
* For EACH ITEM in the collection: Gets the layout of the slide.
|
|
136120
|
+
*
|
|
136121
|
+
* @remarks
|
|
136122
|
+
* [Api set: PowerPointApi 1.3]
|
|
136123
|
+
*/
|
|
136116
136124
|
layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
|
|
136117
136125
|
/**
|
|
136118
|
-
|
|
136119
|
-
|
|
136120
|
-
|
|
136121
|
-
|
|
136122
|
-
|
|
136126
|
+
* For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
|
|
136127
|
+
*
|
|
136128
|
+
* @remarks
|
|
136129
|
+
* [Api set: PowerPointApi 1.3]
|
|
136130
|
+
*/
|
|
136123
136131
|
slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
|
|
136124
136132
|
/**
|
|
136125
136133
|
* For EACH ITEM in the collection: Gets the unique ID of the slide.
|
|
@@ -136148,18 +136156,18 @@ declare namespace PowerPoint {
|
|
|
136148
136156
|
*/
|
|
136149
136157
|
$all?: boolean;
|
|
136150
136158
|
/**
|
|
136151
|
-
|
|
136152
|
-
|
|
136153
|
-
|
|
136154
|
-
|
|
136155
|
-
|
|
136159
|
+
* For EACH ITEM in the collection: Gets the layout of the slide.
|
|
136160
|
+
*
|
|
136161
|
+
* @remarks
|
|
136162
|
+
* [Api set: PowerPointApi 1.5]
|
|
136163
|
+
*/
|
|
136156
136164
|
layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
|
|
136157
136165
|
/**
|
|
136158
|
-
|
|
136159
|
-
|
|
136160
|
-
|
|
136161
|
-
|
|
136162
|
-
|
|
136166
|
+
* For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
|
|
136167
|
+
*
|
|
136168
|
+
* @remarks
|
|
136169
|
+
* [Api set: PowerPointApi 1.5]
|
|
136170
|
+
*/
|
|
136163
136171
|
slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
|
|
136164
136172
|
/**
|
|
136165
136173
|
* For EACH ITEM in the collection: Gets the unique ID of the slide.
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.528",
|
|
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": "
|
|
49
|
+
"typesPublisherContentHash": "055397b64e2c1ae522a2227b94c1303d12230efbe310dbf0bc06393282a61015",
|
|
50
50
|
"typeScriptVersion": "5.2"
|
|
51
51
|
}
|