@types/office-js 1.0.582 → 1.0.584
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 +200 -53
- 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: Fri, 20 Mar 2026 16:26:47 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -11574,7 +11574,7 @@ declare namespace Office {
|
|
|
11574
11574
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11575
11575
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
11576
11576
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
11577
|
-
* the failure.
|
|
11577
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
11578
11578
|
*/
|
|
11579
11579
|
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
11580
11580
|
/**
|
|
@@ -11592,7 +11592,7 @@ declare namespace Office {
|
|
|
11592
11592
|
*
|
|
11593
11593
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
11594
11594
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
11595
|
-
* the failure.
|
|
11595
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
11596
11596
|
*/
|
|
11597
11597
|
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
11598
11598
|
/**
|
|
@@ -13337,13 +13337,43 @@ declare namespace Office {
|
|
|
13337
13337
|
*/
|
|
13338
13338
|
contentId: string;
|
|
13339
13339
|
/**
|
|
13340
|
-
* Gets the
|
|
13340
|
+
* Gets the identifier of an attachment. The value varies depending on the Outlook client.
|
|
13341
|
+
*
|
|
13342
|
+
* - In Outlook on the web and the new Outlook on Windows, the identifier is the Exchange Web Services (EWS) ID.
|
|
13343
|
+
* For inline attachments, the initial identifier is a temporary attachment ID, prefixed with `addinId`, while the attachment is uploaded to the server.
|
|
13344
|
+
* Once the upload completes, the attachment receives an EWS ID. For details, see the notes in the Remarks section.
|
|
13345
|
+
*
|
|
13346
|
+
* - In Outlook on Windows (classic) and on Mac, the identifier for inline and non-inline attachments is the index of the attachment.
|
|
13347
|
+
*
|
|
13348
|
+
* @remarks
|
|
13349
|
+
*
|
|
13350
|
+
* **Important**: Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
13351
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
13352
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
13353
|
+
* For more information on the changes to how inline images are handled, see
|
|
13354
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
13341
13355
|
*/
|
|
13342
13356
|
id: string;
|
|
13343
13357
|
/**
|
|
13344
13358
|
* Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.
|
|
13345
13359
|
*/
|
|
13346
13360
|
isInline: boolean;
|
|
13361
|
+
/**
|
|
13362
|
+
* In Outlook on the web and the new Outlook on Windows, indicates whether an inline attachment in a message has been uploaded to the server and assigned an Exchange Web Services (EWS) ID.
|
|
13363
|
+
*
|
|
13364
|
+
* @remarks
|
|
13365
|
+
*
|
|
13366
|
+
* **Important**:
|
|
13367
|
+
*
|
|
13368
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in Outlook on the web and the new Outlook on Windows
|
|
13369
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
13370
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID in the `id` property and their `isServiceAccessible` property is set to `true`.
|
|
13371
|
+
* The temporary attachment ID is only supported for the duration of the current compose session. For more information on the changes to how inline images are handled, see
|
|
13372
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
13373
|
+
*
|
|
13374
|
+
* - In Outlook on Windows (classic) and on Mac, the `isServiceAccessible` property always returns `false` since the attachment ID is the index of the attachment.
|
|
13375
|
+
*/
|
|
13376
|
+
isServiceAccessible: boolean;
|
|
13347
13377
|
/**
|
|
13348
13378
|
* Gets the name of the attachment.
|
|
13349
13379
|
*
|
|
@@ -16044,12 +16074,6 @@ declare namespace Office {
|
|
|
16044
16074
|
/**
|
|
16045
16075
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
16046
16076
|
*
|
|
16047
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16048
|
-
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
16049
|
-
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16050
|
-
* the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an inline form
|
|
16051
|
-
* then subsequently pops out the form to continue in a separate window.
|
|
16052
|
-
*
|
|
16053
16077
|
* @remarks
|
|
16054
16078
|
* [Api set: Mailbox 1.8]
|
|
16055
16079
|
*
|
|
@@ -16057,6 +16081,24 @@ declare namespace Office {
|
|
|
16057
16081
|
*
|
|
16058
16082
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16059
16083
|
*
|
|
16084
|
+
* **Important**:
|
|
16085
|
+
*
|
|
16086
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16087
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
16088
|
+
*
|
|
16089
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
16090
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
16091
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
16092
|
+
* For more information on the changes to how inline images are handled, see
|
|
16093
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
16094
|
+
*
|
|
16095
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16096
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
16097
|
+
*
|
|
16098
|
+
* - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
|
|
16099
|
+
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
16100
|
+
* continue in a separate window.
|
|
16101
|
+
*
|
|
16060
16102
|
* **Errors**:
|
|
16061
16103
|
*
|
|
16062
16104
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -16064,7 +16106,8 @@ declare namespace Office {
|
|
|
16064
16106
|
*
|
|
16065
16107
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
16066
16108
|
*
|
|
16067
|
-
* @param attachmentId - The identifier of the attachment you want to get.
|
|
16109
|
+
* @param attachmentId - The identifier of the attachment you want to get. In Outlook on the web and the new Outlook on Windows, the temporary attachment ID that's
|
|
16110
|
+
* locally generated for inline images that haven't been uploaded to the server yet are supported for the duration of the current compose session.
|
|
16068
16111
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16069
16112
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16070
16113
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -16075,12 +16118,6 @@ declare namespace Office {
|
|
|
16075
16118
|
/**
|
|
16076
16119
|
* Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.
|
|
16077
16120
|
*
|
|
16078
|
-
* The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16079
|
-
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
16080
|
-
* In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16081
|
-
* the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing an inline form
|
|
16082
|
-
* then subsequently pops out the form to continue in a separate window.
|
|
16083
|
-
*
|
|
16084
16121
|
* @remarks
|
|
16085
16122
|
* [Api set: Mailbox 1.8]
|
|
16086
16123
|
*
|
|
@@ -16088,6 +16125,24 @@ declare namespace Office {
|
|
|
16088
16125
|
*
|
|
16089
16126
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16090
16127
|
*
|
|
16128
|
+
* **Important**:
|
|
16129
|
+
*
|
|
16130
|
+
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16131
|
+
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
16132
|
+
*
|
|
16133
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
16134
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
16135
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
16136
|
+
* For more information on the changes to how inline images are handled, see
|
|
16137
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
16138
|
+
*
|
|
16139
|
+
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16140
|
+
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
16141
|
+
*
|
|
16142
|
+
* - In Outlook on the web, on mobile devices, and in the new Outlook on Windows, the attachment identifier is valid only within the same session.
|
|
16143
|
+
* A session is over when the user closes the app, or if the user starts composing an inline form then subsequently pops out the form to
|
|
16144
|
+
* continue in a separate window.
|
|
16145
|
+
*
|
|
16091
16146
|
* **Errors**:
|
|
16092
16147
|
*
|
|
16093
16148
|
* - `AttachmentTypeNotSupported`: The attachment type isn't supported. Unsupported types include embedded images in Rich Text Format,
|
|
@@ -16095,7 +16150,8 @@ declare namespace Office {
|
|
|
16095
16150
|
*
|
|
16096
16151
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
16097
16152
|
*
|
|
16098
|
-
* @param attachmentId - The identifier of the attachment you want to get.
|
|
16153
|
+
* @param attachmentId - The identifier of the attachment you want to get. In Outlook on the web and the new Outlook on Windows, the temporary attachment ID that's
|
|
16154
|
+
* locally generated for inline images that haven't been uploaded to the server yet are supported for the duration of the current compose session.
|
|
16099
16155
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16100
16156
|
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
16101
16157
|
* an error code with the reason for the failure.
|
|
@@ -16111,11 +16167,22 @@ declare namespace Office {
|
|
|
16111
16167
|
*
|
|
16112
16168
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16113
16169
|
*
|
|
16170
|
+
* **Important**:
|
|
16171
|
+
*
|
|
16172
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
16173
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
16174
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
16175
|
+
* For more information on the changes to how inline images are handled, see
|
|
16176
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
16177
|
+
*
|
|
16178
|
+
* - In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
|
|
16179
|
+
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
16180
|
+
*
|
|
16114
16181
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16115
16182
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16116
16183
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16117
16184
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
16118
|
-
* the failure.
|
|
16185
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
16119
16186
|
*/
|
|
16120
16187
|
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
16121
16188
|
/**
|
|
@@ -16128,9 +16195,20 @@ declare namespace Office {
|
|
|
16128
16195
|
*
|
|
16129
16196
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16130
16197
|
*
|
|
16198
|
+
* **Important**:
|
|
16199
|
+
*
|
|
16200
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
16201
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
16202
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
16203
|
+
* For more information on the changes to how inline images are handled, see
|
|
16204
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
16205
|
+
*
|
|
16206
|
+
* - In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
|
|
16207
|
+
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
16208
|
+
*
|
|
16131
16209
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16132
16210
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
16133
|
-
* the failure.
|
|
16211
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
16134
16212
|
*/
|
|
16135
16213
|
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
16136
16214
|
/**
|
|
@@ -19461,6 +19539,12 @@ declare namespace Office {
|
|
|
19461
19539
|
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
19462
19540
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
19463
19541
|
*
|
|
19542
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in Outlook on the web and the new Outlook on Windows
|
|
19543
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
19544
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID in the `id` property and their `isServiceAccessible` property is set to `true`.
|
|
19545
|
+
* The temporary attachment ID is only supported for the duration of the current compose session. For more information on the changes to how inline images are handled, see
|
|
19546
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
19547
|
+
*
|
|
19464
19548
|
* - Bitmap (BMP) images aren't supported if they're added as inline attachments.
|
|
19465
19549
|
*
|
|
19466
19550
|
* - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
|
|
@@ -19487,9 +19571,10 @@ declare namespace Office {
|
|
|
19487
19571
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19488
19572
|
* `isInline`: If true, indicates that the attachment will be shown inline as an image in the message body and won't be displayed in the attachment list.
|
|
19489
19573
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
19490
|
-
* type `Office.AsyncResult`. On success, the attachment identifier
|
|
19491
|
-
*
|
|
19492
|
-
* the
|
|
19574
|
+
* type `Office.AsyncResult`. On success, the attachment identifier is provided in the `asyncResult.value` property. The identifier varies depending on the Outlook client.
|
|
19575
|
+
* In Outlook on the web and the new Outlook on Windows, the Exchange Web Services (EWS) ID is returned. If `isInline` is set to `true`, a temporary attachment ID prefixed with
|
|
19576
|
+
* `addinId` is initially returned while the attachment is uploaded to the server. Once the upload completes, the attachment is then assigned an EWS ID. For details, see the notes in the Remarks section.
|
|
19577
|
+
* In Outlook on Windows (classic) and on Mac, the index of the attachment is returned for inline and non-inline attachments. If uploading the attachment fails, a description of the error is provided in `asyncResult.error`.
|
|
19493
19578
|
*/
|
|
19494
19579
|
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
19495
19580
|
/**
|
|
@@ -19509,6 +19594,12 @@ declare namespace Office {
|
|
|
19509
19594
|
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
19510
19595
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
19511
19596
|
*
|
|
19597
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in Outlook on the web and the new Outlook on Windows
|
|
19598
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
19599
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID in the `id` property and their `isServiceAccessible` property is set to `true`.
|
|
19600
|
+
* The temporary attachment ID is only supported for the duration of the current compose session. For more information on the changes to how inline images are handled, see
|
|
19601
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
19602
|
+
*
|
|
19512
19603
|
* - Bitmap (BMP) images aren't supported if they're added as inline attachments.
|
|
19513
19604
|
*
|
|
19514
19605
|
* - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
|
|
@@ -19532,9 +19623,10 @@ declare namespace Office {
|
|
|
19532
19623
|
* @param uri - The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
|
|
19533
19624
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
19534
19625
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
19535
|
-
* type `Office.AsyncResult`. On success, the attachment identifier
|
|
19536
|
-
*
|
|
19537
|
-
* the
|
|
19626
|
+
* type `Office.AsyncResult`. On success, the attachment identifier is provided in the `asyncResult.value` property. The identifier varies depending on the Outlook client.
|
|
19627
|
+
* In Outlook on the web and the new Outlook on Windows, the Exchange Web Services (EWS) ID is returned. If `isInline` is set to `true`, a temporary attachment ID prefixed with
|
|
19628
|
+
* `addinId` is initially returned while the attachment is uploaded to the server. Once the upload completes, the attachment is then assigned an EWS ID. For details, see the notes in the Remarks section.
|
|
19629
|
+
* In Outlook on Windows (classic) and on Mac, the index of the attachment is returned for inline and non-inline attachments. If uploading the attachment fails, a description of the error is provided in `asyncResult.error`.
|
|
19538
19630
|
*/
|
|
19539
19631
|
addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
19540
19632
|
/**
|
|
@@ -19557,6 +19649,12 @@ declare namespace Office {
|
|
|
19557
19649
|
* - Adding an inline Base64 file to a message in compose mode is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
19558
19650
|
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
19559
19651
|
*
|
|
19652
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
19653
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
19654
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
19655
|
+
* For more information on the changes to how inline images are handled, see
|
|
19656
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
19657
|
+
*
|
|
19560
19658
|
* - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
|
|
19561
19659
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
19562
19660
|
*
|
|
@@ -19580,9 +19678,11 @@ declare namespace Office {
|
|
|
19580
19678
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19581
19679
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19582
19680
|
* `isInline`: If true, indicates that the attachment will be shown inline as an image in the message body and won't be displayed in the attachment list.
|
|
19583
|
-
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
19584
|
-
*
|
|
19585
|
-
*
|
|
19681
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of type `Office.AsyncResult`.
|
|
19682
|
+
* On success, the attachment identifier is provided in the `asyncResult.value` property. The identifier varies depending on the Outlook client.
|
|
19683
|
+
* In Outlook on the web and the new Outlook on Windows, the Exchange Web Services (EWS) ID is returned. If `isInline` is set to `true`, a temporary attachment ID prefixed with
|
|
19684
|
+
* `addinId` is initially returned while the attachment is uploaded to the server. Once the upload completes, the attachment is then assigned an EWS ID. For details, see the notes in the Remarks section.
|
|
19685
|
+
* In Outlook on Windows (classic) and on Mac, the index of the attachment is returned for inline and non-inline attachments. If uploading the attachment fails, a description of the error is provided in `asyncResult.error`.
|
|
19586
19686
|
*/
|
|
19587
19687
|
addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
19588
19688
|
/**
|
|
@@ -19605,6 +19705,12 @@ declare namespace Office {
|
|
|
19605
19705
|
* - Adding an inline Base64 file to a message in compose mode is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
19606
19706
|
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
19607
19707
|
*
|
|
19708
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
19709
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
19710
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
19711
|
+
* For more information on the changes to how inline images are handled, see
|
|
19712
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
19713
|
+
*
|
|
19608
19714
|
* - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
|
|
19609
19715
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
19610
19716
|
*
|
|
@@ -19625,9 +19731,11 @@ declare namespace Office {
|
|
|
19625
19731
|
*
|
|
19626
19732
|
* @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
|
|
19627
19733
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
19628
|
-
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
19629
|
-
*
|
|
19630
|
-
*
|
|
19734
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of type `Office.AsyncResult`.
|
|
19735
|
+
* On success, the attachment identifier is provided in the `asyncResult.value` property. The identifier varies depending on the Outlook client.
|
|
19736
|
+
* In Outlook on the web and the new Outlook on Windows, the Exchange Web Services (EWS) ID is returned. If `isInline` is set to `true`, a temporary attachment ID prefixed with
|
|
19737
|
+
* `addinId` is initially returned while the attachment is uploaded to the server. Once the upload completes, the attachment is then assigned an EWS ID. For details, see the notes in the Remarks section.
|
|
19738
|
+
* In Outlook on Windows (classic) and on Mac, the index of the attachment is returned for inline and non-inline attachments. If uploading the attachment fails, a description of the error is provided in `asyncResult.error`.
|
|
19631
19739
|
*/
|
|
19632
19740
|
addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
19633
19741
|
/**
|
|
@@ -19910,6 +20018,12 @@ declare namespace Office {
|
|
|
19910
20018
|
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
19911
20019
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
19912
20020
|
*
|
|
20021
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20022
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20023
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20024
|
+
* For more information on the changes to how inline images are handled, see
|
|
20025
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20026
|
+
*
|
|
19913
20027
|
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
19914
20028
|
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
19915
20029
|
*
|
|
@@ -19924,7 +20038,8 @@ declare namespace Office {
|
|
|
19924
20038
|
*
|
|
19925
20039
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
19926
20040
|
*
|
|
19927
|
-
* @param attachmentId - The identifier of the attachment you want to get.
|
|
20041
|
+
* @param attachmentId - The identifier of the attachment you want to get. In Outlook on the web and the new Outlook on Windows, the temporary attachment ID that's
|
|
20042
|
+
* locally generated for inline images that haven't been uploaded to the server yet are supported for the duration of the current compose session.
|
|
19928
20043
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19929
20044
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19930
20045
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -19947,6 +20062,12 @@ declare namespace Office {
|
|
|
19947
20062
|
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
19948
20063
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
19949
20064
|
*
|
|
20065
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20066
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20067
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20068
|
+
* For more information on the changes to how inline images are handled, see
|
|
20069
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20070
|
+
*
|
|
19950
20071
|
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
19951
20072
|
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
19952
20073
|
*
|
|
@@ -19961,7 +20082,8 @@ declare namespace Office {
|
|
|
19961
20082
|
*
|
|
19962
20083
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
19963
20084
|
*
|
|
19964
|
-
* @param attachmentId - The identifier of the attachment you want to get.
|
|
20085
|
+
* @param attachmentId - The identifier of the attachment you want to get. In Outlook on the web and the new Outlook on Windows, the temporary attachment ID that's
|
|
20086
|
+
* locally generated for inline images that haven't been uploaded to the server yet are supported for the duration of the current compose session.
|
|
19965
20087
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
19966
20088
|
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
19967
20089
|
* an error code with the reason for the failure.
|
|
@@ -19977,14 +20099,22 @@ declare namespace Office {
|
|
|
19977
20099
|
*
|
|
19978
20100
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19979
20101
|
*
|
|
19980
|
-
* **Important**:
|
|
20102
|
+
* **Important**:
|
|
20103
|
+
*
|
|
20104
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20105
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20106
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20107
|
+
* For more information on the changes to how inline images are handled, see
|
|
20108
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20109
|
+
*
|
|
20110
|
+
* - In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
|
|
19981
20111
|
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
19982
20112
|
*
|
|
19983
20113
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
19984
20114
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
19985
20115
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
19986
20116
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
19987
|
-
* the failure.
|
|
20117
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
19988
20118
|
*/
|
|
19989
20119
|
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
19990
20120
|
/**
|
|
@@ -19997,12 +20127,20 @@ declare namespace Office {
|
|
|
19997
20127
|
*
|
|
19998
20128
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
19999
20129
|
*
|
|
20000
|
-
* **Important**:
|
|
20130
|
+
* **Important**:
|
|
20131
|
+
*
|
|
20132
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20133
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20134
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20135
|
+
* For more information on the changes to how inline images are handled, see
|
|
20136
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20137
|
+
*
|
|
20138
|
+
* - In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
|
|
20001
20139
|
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
20002
20140
|
*
|
|
20003
20141
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
20004
20142
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
20005
|
-
* the failure.
|
|
20143
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
20006
20144
|
*/
|
|
20007
20145
|
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
20008
20146
|
/**
|
|
@@ -35008,6 +35146,9 @@ declare namespace Excel {
|
|
|
35008
35146
|
interface WorksheetFormulaChangedEventArgs {
|
|
35009
35147
|
/**
|
|
35010
35148
|
* Gets an array of `FormulaChangedEventDetail` objects, which contain the details about the all of the changed formulas.
|
|
35149
|
+
|
|
35150
|
+
If the number of changed formulas or the size of the changed formula text exceeds a size limit, `formulaDetails`
|
|
35151
|
+
returns undefined. This indicates that something on the sheet has changed, but the details cannot be reported.
|
|
35011
35152
|
*
|
|
35012
35153
|
* @remarks
|
|
35013
35154
|
* [Api set: ExcelApi 1.13]
|
|
@@ -37182,6 +37323,9 @@ declare namespace Excel {
|
|
|
37182
37323
|
readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;
|
|
37183
37324
|
/**
|
|
37184
37325
|
* Occurs when one or more formulas are changed in this worksheet. This event is for when the formula itself changes, not the data value resulting from the formula's calculation.
|
|
37326
|
+
|
|
37327
|
+
The event is only triggered when the cell already contains a formula.
|
|
37328
|
+
The new cell value may not include a formula. This event is not triggered when a formula is entered into a cell that did not previously contain a formula.
|
|
37185
37329
|
*
|
|
37186
37330
|
* @remarks
|
|
37187
37331
|
* [Api set: ExcelApi 1.13]
|
|
@@ -38169,6 +38313,7 @@ declare namespace Excel {
|
|
|
38169
38313
|
/**
|
|
38170
38314
|
* Represents the raw values of the specified range. The data returned could be a string, number, or Boolean. Cells that contain an error will return the error string.
|
|
38171
38315
|
If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula.
|
|
38316
|
+
Locale-shaped strings (such as the date "19-8-2025" in nl-NL or fr-FR, format DD-MM-YYYY) are stored as text instead of as dates. To ensure dates are stored as dates, use a locale-aware API like `formulasLocal` or use a locale-neutral format like ISO (YYYY-MM-DD) or a numeric date serial.
|
|
38172
38317
|
*
|
|
38173
38318
|
* @remarks
|
|
38174
38319
|
* [Api set: ExcelApi 1.1]
|
|
@@ -135478,7 +135623,7 @@ declare namespace Word {
|
|
|
135478
135623
|
unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item";
|
|
135479
135624
|
}
|
|
135480
135625
|
/**
|
|
135481
|
-
* Represents the options for the {@link Word.Selection | Selection.
|
|
135626
|
+
* Represents the options for the {@link Word.Selection | Selection.getNextRange} method.
|
|
135482
135627
|
*
|
|
135483
135628
|
* @remarks
|
|
135484
135629
|
* [Api set: WordApiDesktop 1.4]
|
|
@@ -135500,7 +135645,7 @@ declare namespace Word {
|
|
|
135500
135645
|
unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item";
|
|
135501
135646
|
}
|
|
135502
135647
|
/**
|
|
135503
|
-
* Represents the options for the {@link Word.Selection | Selection.
|
|
135648
|
+
* Represents the options for the {@link Word.Selection | Selection.getPreviousRange} method.
|
|
135504
135649
|
*
|
|
135505
135650
|
* @remarks
|
|
135506
135651
|
* [Api set: WordApiDesktop 1.4]
|
|
@@ -140119,7 +140264,7 @@ declare namespace Word {
|
|
|
140119
140264
|
/** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */
|
|
140120
140265
|
interface CommentContentRangeUpdateData {
|
|
140121
140266
|
/**
|
|
140122
|
-
* Specifies
|
|
140267
|
+
* Specifies whether the comment text is bold.
|
|
140123
140268
|
*
|
|
140124
140269
|
* @remarks
|
|
140125
140270
|
* [Api set: WordApi 1.4]
|
|
@@ -140133,21 +140278,21 @@ declare namespace Word {
|
|
|
140133
140278
|
*/
|
|
140134
140279
|
hyperlink?: string;
|
|
140135
140280
|
/**
|
|
140136
|
-
* Specifies
|
|
140281
|
+
* Specifies whether the comment text is italicized.
|
|
140137
140282
|
*
|
|
140138
140283
|
* @remarks
|
|
140139
140284
|
* [Api set: WordApi 1.4]
|
|
140140
140285
|
*/
|
|
140141
140286
|
italic?: boolean;
|
|
140142
140287
|
/**
|
|
140143
|
-
* Specifies
|
|
140288
|
+
* Specifies whether the comment text has a strikethrough.
|
|
140144
140289
|
*
|
|
140145
140290
|
* @remarks
|
|
140146
140291
|
* [Api set: WordApi 1.4]
|
|
140147
140292
|
*/
|
|
140148
140293
|
strikeThrough?: boolean;
|
|
140149
140294
|
/**
|
|
140150
|
-
* Specifies
|
|
140295
|
+
* Specifies the comment text's underline type. `none` if the comment text isn't underlined.
|
|
140151
140296
|
*
|
|
140152
140297
|
* @remarks
|
|
140153
140298
|
* [Api set: WordApi 1.4]
|
|
@@ -145884,7 +146029,7 @@ declare namespace Word {
|
|
|
145884
146029
|
*/
|
|
145885
146030
|
styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
|
|
145886
146031
|
/**
|
|
145887
|
-
* Gets the text of the body. Use the insertText method to insert text.
|
|
146032
|
+
* Gets the text of the body. Use the `insertText` method to insert text.
|
|
145888
146033
|
*
|
|
145889
146034
|
* @remarks
|
|
145890
146035
|
* [Api set: WordApi 1.1]
|
|
@@ -146322,7 +146467,7 @@ declare namespace Word {
|
|
|
146322
146467
|
/** An interface describing the data returned by calling `commentContentRange.toJSON()`. */
|
|
146323
146468
|
interface CommentContentRangeData {
|
|
146324
146469
|
/**
|
|
146325
|
-
* Specifies
|
|
146470
|
+
* Specifies whether the comment text is bold.
|
|
146326
146471
|
*
|
|
146327
146472
|
* @remarks
|
|
146328
146473
|
* [Api set: WordApi 1.4]
|
|
@@ -146343,14 +146488,14 @@ declare namespace Word {
|
|
|
146343
146488
|
*/
|
|
146344
146489
|
isEmpty?: boolean;
|
|
146345
146490
|
/**
|
|
146346
|
-
* Specifies
|
|
146491
|
+
* Specifies whether the comment text is italicized.
|
|
146347
146492
|
*
|
|
146348
146493
|
* @remarks
|
|
146349
146494
|
* [Api set: WordApi 1.4]
|
|
146350
146495
|
*/
|
|
146351
146496
|
italic?: boolean;
|
|
146352
146497
|
/**
|
|
146353
|
-
* Specifies
|
|
146498
|
+
* Specifies whether the comment text has a strikethrough.
|
|
146354
146499
|
*
|
|
146355
146500
|
* @remarks
|
|
146356
146501
|
* [Api set: WordApi 1.4]
|
|
@@ -146364,7 +146509,7 @@ declare namespace Word {
|
|
|
146364
146509
|
*/
|
|
146365
146510
|
text?: string;
|
|
146366
146511
|
/**
|
|
146367
|
-
* Specifies
|
|
146512
|
+
* Specifies the comment text's underline type. `none` if the comment text isn't underlined.
|
|
146368
146513
|
*
|
|
146369
146514
|
* @remarks
|
|
146370
146515
|
* [Api set: WordApi 1.4]
|
|
@@ -154438,7 +154583,7 @@ declare namespace Word {
|
|
|
154438
154583
|
*/
|
|
154439
154584
|
styleBuiltIn?: boolean;
|
|
154440
154585
|
/**
|
|
154441
|
-
* Gets the text of the body. Use the insertText method to insert text.
|
|
154586
|
+
* Gets the text of the body. Use the `insertText` method to insert text.
|
|
154442
154587
|
*
|
|
154443
154588
|
* @remarks
|
|
154444
154589
|
* [Api set: WordApi 1.1]
|
|
@@ -155227,6 +155372,8 @@ declare namespace Word {
|
|
|
155227
155372
|
resolved?: boolean;
|
|
155228
155373
|
}
|
|
155229
155374
|
/**
|
|
155375
|
+
* Represents a content range within a comment.
|
|
155376
|
+
*
|
|
155230
155377
|
* @remarks
|
|
155231
155378
|
* [Api set: WordApi 1.4]
|
|
155232
155379
|
*/
|
|
@@ -155236,7 +155383,7 @@ declare namespace Word {
|
|
|
155236
155383
|
*/
|
|
155237
155384
|
$all?: boolean;
|
|
155238
155385
|
/**
|
|
155239
|
-
* Specifies
|
|
155386
|
+
* Specifies whether the comment text is bold.
|
|
155240
155387
|
*
|
|
155241
155388
|
* @remarks
|
|
155242
155389
|
* [Api set: WordApi 1.4]
|
|
@@ -155257,14 +155404,14 @@ declare namespace Word {
|
|
|
155257
155404
|
*/
|
|
155258
155405
|
isEmpty?: boolean;
|
|
155259
155406
|
/**
|
|
155260
|
-
* Specifies
|
|
155407
|
+
* Specifies whether the comment text is italicized.
|
|
155261
155408
|
*
|
|
155262
155409
|
* @remarks
|
|
155263
155410
|
* [Api set: WordApi 1.4]
|
|
155264
155411
|
*/
|
|
155265
155412
|
italic?: boolean;
|
|
155266
155413
|
/**
|
|
155267
|
-
* Specifies
|
|
155414
|
+
* Specifies whether the comment text has a strikethrough.
|
|
155268
155415
|
*
|
|
155269
155416
|
* @remarks
|
|
155270
155417
|
* [Api set: WordApi 1.4]
|
|
@@ -155278,7 +155425,7 @@ declare namespace Word {
|
|
|
155278
155425
|
*/
|
|
155279
155426
|
text?: boolean;
|
|
155280
155427
|
/**
|
|
155281
|
-
* Specifies
|
|
155428
|
+
* Specifies the comment text's underline type. `none` if the comment text isn't underlined.
|
|
155282
155429
|
*
|
|
155283
155430
|
* @remarks
|
|
155284
155431
|
* [Api set: WordApi 1.4]
|
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.584",
|
|
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": "8adb5a53e024e02bc5e3ea0072125ac2857a385039aa47834089e2a4618c2bc1",
|
|
50
50
|
"typeScriptVersion": "5.2"
|
|
51
51
|
}
|