@types/office-js-preview 1.0.317 → 1.0.320
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +428 -253
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -274,8 +274,8 @@ declare namespace Office {
|
|
|
274
274
|
*
|
|
275
275
|
* **Support details**
|
|
276
276
|
*
|
|
277
|
-
* A capital Y in the following matrix indicates that this
|
|
278
|
-
* An empty cell indicates that the Office host application doesn't support this
|
|
277
|
+
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office host application.
|
|
278
|
+
* An empty cell indicates that the Office host application doesn't support this function.
|
|
279
279
|
*
|
|
280
280
|
* For more information about Office host application and server requirements, see
|
|
281
281
|
* {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
@@ -299,7 +299,7 @@ declare namespace Office {
|
|
|
299
299
|
* also be used outside the add-in. In that case, once Office.js determines that it is running outside of an Office host application, it will call
|
|
300
300
|
* the callback and resolve the promise with "null" for both the host and platform.
|
|
301
301
|
*
|
|
302
|
-
* @param callback - An optional callback
|
|
302
|
+
* @param callback - An optional callback function, that will receive the host and platform info.
|
|
303
303
|
* Alternatively, rather than use a callback, an add-in may simply wait for the Promise returned by the function to resolve.
|
|
304
304
|
* @returns A Promise that contains the host and platform info, once initialization is completed.
|
|
305
305
|
*/
|
|
@@ -311,8 +311,8 @@ declare namespace Office {
|
|
|
311
311
|
*
|
|
312
312
|
* **Support details**
|
|
313
313
|
*
|
|
314
|
-
* A capital Y in the following matrix indicates that this
|
|
315
|
-
* An empty cell indicates that the Office host application doesn't support this
|
|
314
|
+
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office host application.
|
|
315
|
+
* An empty cell indicates that the Office host application doesn't support this function.
|
|
316
316
|
*
|
|
317
317
|
* For more information about Office host application and server requirements, see
|
|
318
318
|
* {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
@@ -1263,7 +1263,7 @@ declare namespace Office {
|
|
|
1263
1263
|
*
|
|
1264
1264
|
* @param startAddress - Accepts the initial full HTTPS URL that opens in the dialog. Relative URLs must not be used.
|
|
1265
1265
|
* @param options - Optional. Accepts an {@link Office.DialogOptions} object to define dialog display.
|
|
1266
|
-
* @param callback - Optional. Accepts a callback
|
|
1266
|
+
* @param callback - Optional. Accepts a callback function to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
|
|
1267
1267
|
*/
|
|
1268
1268
|
displayDialogAsync(startAddress: string, options?: DialogOptions, callback?: (result: AsyncResult<Dialog>) => void): void;
|
|
1269
1269
|
/**
|
|
@@ -1363,7 +1363,7 @@ declare namespace Office {
|
|
|
1363
1363
|
* </table>
|
|
1364
1364
|
*
|
|
1365
1365
|
* @param startAddress - Accepts the initial full HTTPS URL that opens in the dialog. Relative URLs must not be used.
|
|
1366
|
-
* @param callback - Optional. Accepts a callback
|
|
1366
|
+
* @param callback - Optional. Accepts a callback function to handle the dialog creation attempt. If successful, the AsyncResult.value is a Dialog object.
|
|
1367
1367
|
*/
|
|
1368
1368
|
displayDialogAsync(startAddress: string, callback?: (result: AsyncResult<Dialog>) => void): void;
|
|
1369
1369
|
/**
|
|
@@ -1497,7 +1497,7 @@ declare namespace Office {
|
|
|
1497
1497
|
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
|
|
1498
1498
|
*
|
|
1499
1499
|
* @param options - Optional. Accepts an `AuthOptions` object to define sign-on behaviors.
|
|
1500
|
-
* @param callback - Optional. Accepts a callback
|
|
1500
|
+
* @param callback - Optional. Accepts a callback function that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
|
|
1501
1501
|
* If `AsyncResult.status` is "succeeded", then `AsyncResult.value` is the raw AAD v. 2.0-formatted access token.
|
|
1502
1502
|
*/
|
|
1503
1503
|
getAccessTokenAsync(options?: AuthOptions, callback?: (result: AsyncResult<string>) => void): void;
|
|
@@ -1521,7 +1521,7 @@ declare namespace Office {
|
|
|
1521
1521
|
* This API requires a single sign-on configuration that bridges the add-in to an Azure application. Office users sign in with Organizational
|
|
1522
1522
|
* Accounts and Microsoft Accounts. Microsoft Azure returns tokens intended for both user account types to access resources in the Microsoft Graph.
|
|
1523
1523
|
*
|
|
1524
|
-
* @param callback - Optional. Accepts a callback
|
|
1524
|
+
* @param callback - Optional. Accepts a callback function that can parse the token for the user's ID or use the token in the "on behalf of" flow to get access to Microsoft Graph.
|
|
1525
1525
|
* If `AsyncResult.status` is "succeeded", then `AsyncResult.value` is the raw AAD v. 2.0-formatted access token.
|
|
1526
1526
|
*/
|
|
1527
1527
|
getAccessTokenAsync(callback?: (result: AsyncResult<string>) => void): void;
|
|
@@ -2045,7 +2045,7 @@ declare namespace Office {
|
|
|
2045
2045
|
}
|
|
2046
2046
|
|
|
2047
2047
|
/**
|
|
2048
|
-
* Returns a promise of an object described in the expression. Callback is invoked only if
|
|
2048
|
+
* Returns a promise of an object described in the expression. Callback is invoked only if the function fails.
|
|
2049
2049
|
*
|
|
2050
2050
|
* @param expression The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'
|
|
2051
2051
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
@@ -2054,8 +2054,8 @@ declare namespace Office {
|
|
|
2054
2054
|
*
|
|
2055
2055
|
* **Support details**
|
|
2056
2056
|
*
|
|
2057
|
-
* A capital Y in the following matrix indicates that this
|
|
2058
|
-
* An empty cell indicates that the Office host application doesn't support this
|
|
2057
|
+
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office host application.
|
|
2058
|
+
* An empty cell indicates that the Office host application doesn't support this function.
|
|
2059
2059
|
*
|
|
2060
2060
|
* For more information about Office host application and server requirements, see
|
|
2061
2061
|
* {@link https://docs.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
@@ -9888,7 +9888,7 @@ declare namespace Office {
|
|
|
9888
9888
|
* @param uri - The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
|
|
9889
9889
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
9890
9890
|
* @param options - An object literal that contains one or more of the following properties.
|
|
9891
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
9891
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
9892
9892
|
* `isInline`: If true, indicates that the attachment will be shown inline in the message body,
|
|
9893
9893
|
* and should not be displayed in the attachment list.
|
|
9894
9894
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
@@ -9962,7 +9962,7 @@ declare namespace Office {
|
|
|
9962
9962
|
* @param base64File - The base64 encoded content of an image or file to be added to an email or event.
|
|
9963
9963
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
9964
9964
|
* @param options - An object literal that contains one or more of the following properties.
|
|
9965
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
9965
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
9966
9966
|
* `isInline`: If true, indicates that the attachment will be shown inline in the message body
|
|
9967
9967
|
* and should not be displayed in the attachment list.
|
|
9968
9968
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
@@ -10024,7 +10024,7 @@ declare namespace Office {
|
|
|
10024
10024
|
* @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
|
|
10025
10025
|
* The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
|
|
10026
10026
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10027
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10027
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10028
10028
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
10029
10029
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
10030
10030
|
*/
|
|
@@ -10053,9 +10053,9 @@ declare namespace Office {
|
|
|
10053
10053
|
* Adds an Exchange item, such as a message, as an attachment to the message or appointment.
|
|
10054
10054
|
*
|
|
10055
10055
|
* The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form.
|
|
10056
|
-
* If you specify a callback
|
|
10056
|
+
* If you specify a callback function, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
|
|
10057
10057
|
* a code that indicates any error that occurred while attaching the item.
|
|
10058
|
-
* You can use the `options` parameter to pass state information to the callback
|
|
10058
|
+
* You can use the `options` parameter to pass state information to the callback function, if needed.
|
|
10059
10059
|
*
|
|
10060
10060
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
10061
10061
|
*
|
|
@@ -10076,7 +10076,7 @@ declare namespace Office {
|
|
|
10076
10076
|
* @param itemId - The Exchange identifier of the item to attach. The maximum length is 100 characters.
|
|
10077
10077
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
10078
10078
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10079
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10079
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10080
10080
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of
|
|
10081
10081
|
* type `Office.AsyncResult`.
|
|
10082
10082
|
* On success, the attachment identifier will be provided in the `asyncResult.value` property.
|
|
@@ -10088,9 +10088,9 @@ declare namespace Office {
|
|
|
10088
10088
|
* Adds an Exchange item, such as a message, as an attachment to the message or appointment.
|
|
10089
10089
|
*
|
|
10090
10090
|
* The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form.
|
|
10091
|
-
* If you specify a callback
|
|
10091
|
+
* If you specify a callback function, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
|
|
10092
10092
|
* a code that indicates any error that occurred while attaching the item.
|
|
10093
|
-
* You can use the `options` parameter to pass state information to the callback
|
|
10093
|
+
* You can use the `options` parameter to pass state information to the callback function, if needed.
|
|
10094
10094
|
*
|
|
10095
10095
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
10096
10096
|
*
|
|
@@ -10152,7 +10152,7 @@ declare namespace Office {
|
|
|
10152
10152
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10153
10153
|
*
|
|
10154
10154
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10155
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10155
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10156
10156
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
10157
10157
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
10158
10158
|
*/
|
|
@@ -10201,7 +10201,7 @@ declare namespace Office {
|
|
|
10201
10201
|
*
|
|
10202
10202
|
* @param attachmentId - The identifier of the attachment you want to get.
|
|
10203
10203
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10204
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10204
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10205
10205
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
10206
10206
|
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
10207
10207
|
* an error code with the reason for the failure.
|
|
@@ -10247,7 +10247,7 @@ declare namespace Office {
|
|
|
10247
10247
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10248
10248
|
*
|
|
10249
10249
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10250
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10250
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10251
10251
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
10252
10252
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
10253
10253
|
* the failure.
|
|
@@ -10284,7 +10284,7 @@ declare namespace Office {
|
|
|
10284
10284
|
* More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}.
|
|
10285
10285
|
*
|
|
10286
10286
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10287
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10287
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10288
10288
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
10289
10289
|
* of type `Office.AsyncResult`.
|
|
10290
10290
|
* On success, the initialization context data is provided in the `asyncResult.value` property as a string.
|
|
@@ -10321,7 +10321,7 @@ declare namespace Office {
|
|
|
10321
10321
|
/**
|
|
10322
10322
|
* Asynchronously gets the ID of a saved item.
|
|
10323
10323
|
*
|
|
10324
|
-
* When invoked, this method returns the item ID via the callback
|
|
10324
|
+
* When invoked, this method returns the item ID via the callback function.
|
|
10325
10325
|
*
|
|
10326
10326
|
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
|
|
10327
10327
|
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
@@ -10339,7 +10339,7 @@ declare namespace Office {
|
|
|
10339
10339
|
* - `ItemNotSaved`: The id can't be retrieved until the item is saved.
|
|
10340
10340
|
*
|
|
10341
10341
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10342
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10342
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10343
10343
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
10344
10344
|
* of type `Office.AsyncResult`.
|
|
10345
10345
|
*/
|
|
@@ -10347,7 +10347,7 @@ declare namespace Office {
|
|
|
10347
10347
|
/**
|
|
10348
10348
|
* Asynchronously gets the ID of a saved item.
|
|
10349
10349
|
*
|
|
10350
|
-
* When invoked, this method returns the item ID via the callback
|
|
10350
|
+
* When invoked, this method returns the item ID via the callback function.
|
|
10351
10351
|
*
|
|
10352
10352
|
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
|
|
10353
10353
|
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
@@ -10374,7 +10374,7 @@ declare namespace Office {
|
|
|
10374
10374
|
* If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data.
|
|
10375
10375
|
* If a field other than the body or subject is selected, the method returns the `InvalidSelection` error.
|
|
10376
10376
|
*
|
|
10377
|
-
* To access the selected data from the callback
|
|
10377
|
+
* To access the selected data from the callback function, call `asyncResult.value.data`.
|
|
10378
10378
|
* To access the `source` property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`.
|
|
10379
10379
|
*
|
|
10380
10380
|
* @returns
|
|
@@ -10390,7 +10390,7 @@ declare namespace Office {
|
|
|
10390
10390
|
* @param coercionType - Requests a format for the data. If `Text`, the method returns the plain text as a string, removing any HTML tags present.
|
|
10391
10391
|
* If `HTML`, the method returns the selected text, whether it is plaintext or HTML.
|
|
10392
10392
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10393
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10393
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10394
10394
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
10395
10395
|
* of type `Office.AsyncResult`.
|
|
10396
10396
|
*/
|
|
@@ -10401,7 +10401,7 @@ declare namespace Office {
|
|
|
10401
10401
|
* If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data.
|
|
10402
10402
|
* If a field other than the body or subject is selected, the method returns the `InvalidSelection` error.
|
|
10403
10403
|
*
|
|
10404
|
-
* To access the selected data from the callback
|
|
10404
|
+
* To access the selected data from the callback function, call `asyncResult.value.data`.
|
|
10405
10405
|
* To access the `source` property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`.
|
|
10406
10406
|
*
|
|
10407
10407
|
* @returns
|
|
@@ -10436,7 +10436,7 @@ declare namespace Office {
|
|
|
10436
10436
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10437
10437
|
*
|
|
10438
10438
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10439
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10439
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10440
10440
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
10441
10441
|
* type `Office.AsyncResult`.
|
|
10442
10442
|
* The `value` property of the result is the properties of the shared item.
|
|
@@ -10478,7 +10478,7 @@ declare namespace Office {
|
|
|
10478
10478
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
10479
10479
|
*
|
|
10480
10480
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10481
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10481
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10482
10482
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
10483
10483
|
* type `Office.AsyncResult`.
|
|
10484
10484
|
*/
|
|
@@ -10548,7 +10548,7 @@ declare namespace Office {
|
|
|
10548
10548
|
* @param attachmentId - The identifier of the attachment to remove. The maximum string length of the `attachmentId`
|
|
10549
10549
|
* is 200 characters in Outlook on the web and on Windows.
|
|
10550
10550
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10551
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10551
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10552
10552
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
10553
10553
|
* type `Office.AsyncResult`.
|
|
10554
10554
|
* If removing the attachment fails, the `asyncResult.error` property will contain an error code with the reason for the failure.
|
|
@@ -10596,7 +10596,7 @@ declare namespace Office {
|
|
|
10596
10596
|
*
|
|
10597
10597
|
* @param eventType - The event that should revoke the handler.
|
|
10598
10598
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10599
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10599
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10600
10600
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
10601
10601
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
10602
10602
|
*/
|
|
@@ -10622,7 +10622,7 @@ declare namespace Office {
|
|
|
10622
10622
|
/**
|
|
10623
10623
|
* Asynchronously saves an item.
|
|
10624
10624
|
*
|
|
10625
|
-
* When invoked, this method saves the current message as a draft and returns the item ID via the callback
|
|
10625
|
+
* When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
|
|
10626
10626
|
* In Outlook on the web or Outlook in online mode, the item is saved to the server.
|
|
10627
10627
|
* In Outlook in cached mode, the item is saved to the local cache.
|
|
10628
10628
|
*
|
|
@@ -10653,7 +10653,7 @@ declare namespace Office {
|
|
|
10653
10653
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
10654
10654
|
*
|
|
10655
10655
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10656
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10656
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10657
10657
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
10658
10658
|
* type `Office.AsyncResult`.
|
|
10659
10659
|
*/
|
|
@@ -10661,7 +10661,7 @@ declare namespace Office {
|
|
|
10661
10661
|
/**
|
|
10662
10662
|
* Asynchronously saves an item.
|
|
10663
10663
|
*
|
|
10664
|
-
* When invoked, this method saves the current message as a draft and returns the item ID via the callback
|
|
10664
|
+
* When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
|
|
10665
10665
|
* In Outlook on the web or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache.
|
|
10666
10666
|
*
|
|
10667
10667
|
* Since appointments have no draft state, if `saveAsync` is called on an appointment in compose mode, the item will be saved as a normal
|
|
@@ -10715,7 +10715,7 @@ declare namespace Office {
|
|
|
10715
10715
|
* @param data - The data to be inserted. Data is not to exceed 1,000,000 characters.
|
|
10716
10716
|
* If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown.
|
|
10717
10717
|
* @param options - An object literal that contains one or more of the following properties.
|
|
10718
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
10718
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
10719
10719
|
* `coercionType`: If text, the current style is applied in Outlook on the web and Windows.
|
|
10720
10720
|
* If the field is an HTML editor, only the text data is inserted, even if the data is HTML.
|
|
10721
10721
|
* If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the
|
|
@@ -11288,7 +11288,7 @@ declare namespace Office {
|
|
|
11288
11288
|
* @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
|
|
11289
11289
|
* The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
|
|
11290
11290
|
* @param options - An object literal that contains one or more of the following properties.
|
|
11291
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
11291
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11292
11292
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
11293
11293
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
11294
11294
|
*/
|
|
@@ -11359,7 +11359,7 @@ declare namespace Office {
|
|
|
11359
11359
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
11360
11360
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
11361
11361
|
* @param options - An object literal that contains one or more of the following properties.
|
|
11362
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
11362
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11363
11363
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
11364
11364
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
11365
11365
|
*/
|
|
@@ -11434,7 +11434,7 @@ declare namespace Office {
|
|
|
11434
11434
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
11435
11435
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
11436
11436
|
* @param options - An object literal that contains one or more of the following properties.
|
|
11437
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
11437
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11438
11438
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
11439
11439
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
11440
11440
|
*/
|
|
@@ -11489,7 +11489,7 @@ declare namespace Office {
|
|
|
11489
11489
|
*
|
|
11490
11490
|
* @param attachmentId - The identifier of the attachment you want to get.
|
|
11491
11491
|
* @param options - An object literal that contains one or more of the following properties.
|
|
11492
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
11492
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11493
11493
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
11494
11494
|
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
11495
11495
|
* an error code with the reason for the failure.
|
|
@@ -11538,7 +11538,7 @@ declare namespace Office {
|
|
|
11538
11538
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11539
11539
|
*
|
|
11540
11540
|
* @param options - An object literal that contains one or more of the following properties.
|
|
11541
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
11541
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11542
11542
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
11543
11543
|
* of type `Office.AsyncResult`.
|
|
11544
11544
|
* On success, the initialization context data is provided in the `asyncResult.value` property as a string.
|
|
@@ -11780,7 +11780,7 @@ declare namespace Office {
|
|
|
11780
11780
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
|
|
11781
11781
|
*
|
|
11782
11782
|
* @param options - An object literal that contains one or more of the following properties.
|
|
11783
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
11783
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11784
11784
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
11785
11785
|
* type `Office.AsyncResult`.
|
|
11786
11786
|
* The `value` property of the result is the properties of the shared item.
|
|
@@ -11844,7 +11844,7 @@ declare namespace Office {
|
|
|
11844
11844
|
*
|
|
11845
11845
|
* @param eventType - The event that should revoke the handler.
|
|
11846
11846
|
* @param options - An object literal that contains one or more of the following properties.
|
|
11847
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
11847
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11848
11848
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
11849
11849
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
11850
11850
|
*/
|
|
@@ -12096,7 +12096,7 @@ declare namespace Office {
|
|
|
12096
12096
|
*
|
|
12097
12097
|
* @param data - The string to be added to the end of the body. The string is limited to 5,000 characters.
|
|
12098
12098
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12099
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12099
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12100
12100
|
* `coercionType`: The desired format for the data to be appended. The string in the `data` parameter will be converted to this format.
|
|
12101
12101
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12102
12102
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
@@ -12154,7 +12154,7 @@ declare namespace Office {
|
|
|
12154
12154
|
*
|
|
12155
12155
|
* @param coercionType - The format for the returned body.
|
|
12156
12156
|
* @param options - An object literal that contains one or more of the following properties:
|
|
12157
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12157
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12158
12158
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12159
12159
|
* of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
|
|
12160
12160
|
*/
|
|
@@ -12191,7 +12191,7 @@ declare namespace Office {
|
|
|
12191
12191
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12192
12192
|
*
|
|
12193
12193
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12194
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12194
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12195
12195
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12196
12196
|
* of type `Office.AsyncResult`.
|
|
12197
12197
|
* The content type is returned as one of the `CoercionType` values in the `asyncResult.value` property.
|
|
@@ -12240,7 +12240,7 @@ declare namespace Office {
|
|
|
12240
12240
|
*
|
|
12241
12241
|
* @param data - The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters.
|
|
12242
12242
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12243
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12243
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12244
12244
|
* `coercionType`: The desired format for the body. The string in the `data` parameter will be converted to this format.
|
|
12245
12245
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12246
12246
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
@@ -12306,7 +12306,7 @@ declare namespace Office {
|
|
|
12306
12306
|
*
|
|
12307
12307
|
* @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters.
|
|
12308
12308
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12309
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12309
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12310
12310
|
* `coercionType`: The desired format for the body. The string in the `data` parameter will be converted to this format.
|
|
12311
12311
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12312
12312
|
* of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
@@ -12371,7 +12371,7 @@ declare namespace Office {
|
|
|
12371
12371
|
*
|
|
12372
12372
|
* @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters.
|
|
12373
12373
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12374
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12374
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12375
12375
|
* `coercionType`: The desired format for the body. The string in the `data` parameter will be converted to this format.
|
|
12376
12376
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12377
12377
|
* of type `Office.AsyncResult`. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
@@ -12434,7 +12434,7 @@ declare namespace Office {
|
|
|
12434
12434
|
*
|
|
12435
12435
|
* @param data - The string that represents the signature to be set in the body of the mail. This string is limited to 30,000 characters.
|
|
12436
12436
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12437
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12437
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12438
12438
|
* `coercionType`: The format the signature should be set to. If Text, the method sets the signature to plain text,
|
|
12439
12439
|
* removing any HTML tags present. If Html, the method sets the signature to HTML.
|
|
12440
12440
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
@@ -12508,7 +12508,7 @@ declare namespace Office {
|
|
|
12508
12508
|
*
|
|
12509
12509
|
* @param categories - The categories to be added to the item.
|
|
12510
12510
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12511
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12511
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12512
12512
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
12513
12513
|
* type `Office.AsyncResult`.
|
|
12514
12514
|
*/
|
|
@@ -12553,7 +12553,7 @@ declare namespace Office {
|
|
|
12553
12553
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
12554
12554
|
*
|
|
12555
12555
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12556
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12556
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12557
12557
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
12558
12558
|
* type `Office.AsyncResult`. If getting categories fails, the `asyncResult.error` property will contain an error code.
|
|
12559
12559
|
*/
|
|
@@ -12593,7 +12593,7 @@ declare namespace Office {
|
|
|
12593
12593
|
*
|
|
12594
12594
|
* @param categories - The categories to be removed from the item.
|
|
12595
12595
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12596
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12596
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12597
12597
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
12598
12598
|
* type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code.
|
|
12599
12599
|
*/
|
|
@@ -12746,7 +12746,7 @@ declare namespace Office {
|
|
|
12746
12746
|
* In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes
|
|
12747
12747
|
* disconnected.
|
|
12748
12748
|
* If the add-in calls `saveAsync` while in the disconnected state, `saveAsync` would return an error.
|
|
12749
|
-
* Your callback
|
|
12749
|
+
* Your callback function should handle this error accordingly.
|
|
12750
12750
|
*
|
|
12751
12751
|
* @remarks
|
|
12752
12752
|
*
|
|
@@ -12756,7 +12756,7 @@ declare namespace Office {
|
|
|
12756
12756
|
*
|
|
12757
12757
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
12758
12758
|
* type `Office.AsyncResult`.
|
|
12759
|
-
* @param asyncContext - Optional. Any state data that is passed to the callback
|
|
12759
|
+
* @param asyncContext - Optional. Any state data that is passed to the callback function.
|
|
12760
12760
|
*/
|
|
12761
12761
|
saveAsync(callback: (asyncResult: Office.AsyncResult<void>) => void, asyncContext?: any): void;
|
|
12762
12762
|
/**
|
|
@@ -12769,7 +12769,7 @@ declare namespace Office {
|
|
|
12769
12769
|
* In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes
|
|
12770
12770
|
* disconnected.
|
|
12771
12771
|
* If the add-in calls `saveAsync` while in the disconnected state, `saveAsync` would return an error.
|
|
12772
|
-
* Your callback
|
|
12772
|
+
* Your callback function should handle this error accordingly.
|
|
12773
12773
|
*
|
|
12774
12774
|
* @remarks
|
|
12775
12775
|
*
|
|
@@ -12777,7 +12777,7 @@ declare namespace Office {
|
|
|
12777
12777
|
*
|
|
12778
12778
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
12779
12779
|
*
|
|
12780
|
-
* @param asyncContext - Optional. Any state data that is passed to the callback
|
|
12780
|
+
* @param asyncContext - Optional. Any state data that is passed to the callback function.
|
|
12781
12781
|
*/
|
|
12782
12782
|
saveAsync(asyncContext?: any): void;
|
|
12783
12783
|
/**
|
|
@@ -12824,7 +12824,7 @@ declare namespace Office {
|
|
|
12824
12824
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
12825
12825
|
*
|
|
12826
12826
|
* @param options - An object literal that contains one or more of the following properties:
|
|
12827
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12827
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12828
12828
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
12829
12829
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
12830
12830
|
*
|
|
@@ -12859,7 +12859,7 @@ declare namespace Office {
|
|
|
12859
12859
|
*
|
|
12860
12860
|
* @param datetime - The future date and time when the message should be sent.
|
|
12861
12861
|
* @param options - An object literal that contains one or more of the following properties.
|
|
12862
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
12862
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
12863
12863
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
12864
12864
|
* of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
12865
12865
|
*
|
|
@@ -13035,7 +13035,7 @@ declare namespace Office {
|
|
|
13035
13035
|
*
|
|
13036
13036
|
* @param locationIdentifiers The locations to be added to the current list of locations.
|
|
13037
13037
|
* @param options An object literal that contains one or more of the following properties.
|
|
13038
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13038
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13039
13039
|
* @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13040
13040
|
* `asyncResult`, which is an `Office.AsyncResult` object. Check the `status` property of `asyncResult` to determine if the call succeeded.
|
|
13041
13041
|
*/
|
|
@@ -13070,7 +13070,7 @@ declare namespace Office {
|
|
|
13070
13070
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
13071
13071
|
*
|
|
13072
13072
|
* @param options An object literal that contains one or more of the following properties.
|
|
13073
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13073
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13074
13074
|
* @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13075
13075
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
13076
13076
|
*/
|
|
@@ -13103,7 +13103,7 @@ declare namespace Office {
|
|
|
13103
13103
|
*
|
|
13104
13104
|
* @param locationIdentifiers The locations to be removed from the current list of locations.
|
|
13105
13105
|
* @param options An object literal that contains one or more of the following properties.
|
|
13106
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13106
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13107
13107
|
* @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13108
13108
|
* `asyncResult`, which is an `Office.AsyncResult` object. Check the `status` property of `asyncResult` to determine if the call succeeded.
|
|
13109
13109
|
*/
|
|
@@ -13236,7 +13236,7 @@ declare namespace Office {
|
|
|
13236
13236
|
* The email sender is always a user whose email address is on the Exchange server.
|
|
13237
13237
|
*
|
|
13238
13238
|
* @param options - An object literal that contains one or more of the following properties.
|
|
13239
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13239
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13240
13240
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13241
13241
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
13242
13242
|
* The `value` property of the result is the item's from value, as an `EmailAddressDetails` object.
|
|
@@ -13353,7 +13353,7 @@ declare namespace Office {
|
|
|
13353
13353
|
*
|
|
13354
13354
|
* @param names - The names of the internet headers to be returned.
|
|
13355
13355
|
* @param options - An object literal that contains one or more of the following properties:
|
|
13356
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13356
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13357
13357
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13358
13358
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
13359
13359
|
*/
|
|
@@ -13390,7 +13390,7 @@ declare namespace Office {
|
|
|
13390
13390
|
*
|
|
13391
13391
|
* @param names - The names of the internet headers to be removed.
|
|
13392
13392
|
* @param options - An object literal that contains one or more of the following properties:
|
|
13393
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13393
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13394
13394
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13395
13395
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
13396
13396
|
*/
|
|
@@ -13430,7 +13430,7 @@ declare namespace Office {
|
|
|
13430
13430
|
* @param headers - The names and corresponding values of the headers to be set. Should be a dictionary object with keys being the names of the
|
|
13431
13431
|
* internet headers and values being the values of the internet headers.
|
|
13432
13432
|
* @param options - An object literal that contains one or more of the following properties.
|
|
13433
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13433
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13434
13434
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
13435
13435
|
* of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
|
|
13436
13436
|
*/
|
|
@@ -13580,7 +13580,7 @@ declare namespace Office {
|
|
|
13580
13580
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
13581
13581
|
*
|
|
13582
13582
|
* @param options - An object literal that contains one or more of the following properties.
|
|
13583
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13583
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13584
13584
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
13585
13585
|
* type `Office.AsyncResult`.
|
|
13586
13586
|
*/
|
|
@@ -13621,7 +13621,7 @@ declare namespace Office {
|
|
|
13621
13621
|
*
|
|
13622
13622
|
* @param location - The location of the appointment. The string is limited to 255 characters.
|
|
13623
13623
|
* @param options - An object literal that contains one or more of the following properties.
|
|
13624
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13624
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13625
13625
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
13626
13626
|
* type `Office.AsyncResult`. If setting the location fails, the `asyncResult.error` property will contain an error code.
|
|
13627
13627
|
*/
|
|
@@ -13990,7 +13990,7 @@ declare namespace Office {
|
|
|
13990
13990
|
*
|
|
13991
13991
|
* @param itemId - The Exchange Web Services (EWS) identifier for an existing calendar appointment.
|
|
13992
13992
|
* @param options - An object literal that contains one or more of the following properties.
|
|
13993
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
13993
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
13994
13994
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
13995
13995
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
13996
13996
|
*/
|
|
@@ -14073,7 +14073,7 @@ declare namespace Office {
|
|
|
14073
14073
|
*
|
|
14074
14074
|
* @param itemId - The Exchange Web Services (EWS) identifier for an existing message.
|
|
14075
14075
|
* @param options - An object literal that contains one or more of the following properties.
|
|
14076
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
14076
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14077
14077
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14078
14078
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
14079
14079
|
*/
|
|
@@ -14160,7 +14160,7 @@ declare namespace Office {
|
|
|
14160
14160
|
*
|
|
14161
14161
|
* @param parameters - An `AppointmentForm` describing the new appointment. All properties are optional.
|
|
14162
14162
|
* @param options - An object literal that contains one or more of the following properties.
|
|
14163
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
14163
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14164
14164
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14165
14165
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
14166
14166
|
*/
|
|
@@ -14288,7 +14288,7 @@ declare namespace Office {
|
|
|
14288
14288
|
* `attachments.itemId`: Only used if type is set to item. The EWS item id of the existing e-mail you want to attach to the new message.
|
|
14289
14289
|
* This is a string up to 100 characters.
|
|
14290
14290
|
* @param options - An object literal that contains one or more of the following properties.
|
|
14291
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
14291
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14292
14292
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
14293
14293
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
14294
14294
|
*/
|
|
@@ -14614,7 +14614,7 @@ declare namespace Office {
|
|
|
14614
14614
|
*
|
|
14615
14615
|
* @param categories - The categories to be added to the master list on the mailbox.
|
|
14616
14616
|
* @param options - An object literal that contains one or more of the following properties.
|
|
14617
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
14617
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14618
14618
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
14619
14619
|
* type `Office.AsyncResult`.
|
|
14620
14620
|
*/
|
|
@@ -14651,7 +14651,7 @@ declare namespace Office {
|
|
|
14651
14651
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
14652
14652
|
*
|
|
14653
14653
|
* @param options - An object literal that contains one or more of the following properties.
|
|
14654
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
14654
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14655
14655
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
14656
14656
|
* type `Office.AsyncResult`. If adding categories fails, the `asyncResult.error` property will contain an error code.
|
|
14657
14657
|
*/
|
|
@@ -14686,7 +14686,7 @@ declare namespace Office {
|
|
|
14686
14686
|
*
|
|
14687
14687
|
* @param categories - The categories to be removed from the master list on the mailbox.
|
|
14688
14688
|
* @param options - An object literal that contains one or more of the following properties.
|
|
14689
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
14689
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
14690
14690
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
14691
14691
|
* type `Office.AsyncResult`. If removing categories fails, the `asyncResult.error` property will contain an error code.
|
|
14692
14692
|
*/
|
|
@@ -15014,7 +15014,7 @@ declare namespace Office {
|
|
|
15014
15014
|
* @param uri - The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
|
|
15015
15015
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
15016
15016
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15017
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15017
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15018
15018
|
* `isInline`: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the
|
|
15019
15019
|
* attachment list.
|
|
15020
15020
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
@@ -15086,7 +15086,7 @@ declare namespace Office {
|
|
|
15086
15086
|
* @param base64File - The base64-encoded content of an image or file to be added to an email or event.
|
|
15087
15087
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
15088
15088
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15089
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15089
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15090
15090
|
* `isInline`: If true, indicates that the attachment will be shown inline in the message body and should not be displayed in the attachment list.
|
|
15091
15091
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15092
15092
|
* type Office.AsyncResult. On success, the attachment identifier will be provided in the `asyncResult.value` property.
|
|
@@ -15143,7 +15143,7 @@ declare namespace Office {
|
|
|
15143
15143
|
* @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
|
|
15144
15144
|
* The `type` property on the parameter will match the `eventType` parameter passed to `addHandlerAsync`.
|
|
15145
15145
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15146
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15146
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15147
15147
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
15148
15148
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
15149
15149
|
*/
|
|
@@ -15172,9 +15172,9 @@ declare namespace Office {
|
|
|
15172
15172
|
* Adds an Exchange item, such as a message, as an attachment to the message or appointment.
|
|
15173
15173
|
*
|
|
15174
15174
|
* The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form.
|
|
15175
|
-
* If you specify a callback
|
|
15175
|
+
* If you specify a callback function, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
|
|
15176
15176
|
* a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the
|
|
15177
|
-
* callback
|
|
15177
|
+
* callback function, if needed.
|
|
15178
15178
|
*
|
|
15179
15179
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
15180
15180
|
*
|
|
@@ -15195,7 +15195,7 @@ declare namespace Office {
|
|
|
15195
15195
|
* @param itemId - The Exchange identifier of the item to attach. The maximum length is 100 characters.
|
|
15196
15196
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
15197
15197
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15198
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15198
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15199
15199
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15200
15200
|
* type `Office.AsyncResult`. On success, the attachment identifier will be provided in the `asyncResult.value` property.
|
|
15201
15201
|
* If adding the attachment fails, the `asyncResult` object will contain an `Error` object that provides a description of
|
|
@@ -15206,9 +15206,9 @@ declare namespace Office {
|
|
|
15206
15206
|
* Adds an Exchange item, such as a message, as an attachment to the message or appointment.
|
|
15207
15207
|
*
|
|
15208
15208
|
* The `addItemAttachmentAsync` method attaches the item with the specified Exchange identifier to the item in the compose form.
|
|
15209
|
-
* If you specify a callback
|
|
15209
|
+
* If you specify a callback function, the method is called with one parameter, `asyncResult`, which contains either the attachment identifier or
|
|
15210
15210
|
* a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the
|
|
15211
|
-
* callback
|
|
15211
|
+
* callback function, if needed.
|
|
15212
15212
|
*
|
|
15213
15213
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
15214
15214
|
*
|
|
@@ -15269,7 +15269,7 @@ declare namespace Office {
|
|
|
15269
15269
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15270
15270
|
*
|
|
15271
15271
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15272
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15272
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15273
15273
|
* @param callback - Optional. When the method completes, the function passed in the callback parameter is called with a single parameter,
|
|
15274
15274
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
15275
15275
|
*/
|
|
@@ -15318,7 +15318,7 @@ declare namespace Office {
|
|
|
15318
15318
|
*
|
|
15319
15319
|
* @param attachmentId - The identifier of the attachment you want to get.
|
|
15320
15320
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15321
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15321
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15322
15322
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
15323
15323
|
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
15324
15324
|
* an error code with the reason for the failure.
|
|
@@ -15364,7 +15364,7 @@ declare namespace Office {
|
|
|
15364
15364
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15365
15365
|
*
|
|
15366
15366
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15367
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15367
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15368
15368
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15369
15369
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
15370
15370
|
* the failure.
|
|
@@ -15397,7 +15397,7 @@ declare namespace Office {
|
|
|
15397
15397
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15398
15398
|
*
|
|
15399
15399
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15400
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15400
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15401
15401
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15402
15402
|
* type `Office.AsyncResult`. On success, the `asyncResult.value` property contains an object with the item's compose type
|
|
15403
15403
|
* and coercion type.
|
|
@@ -15441,7 +15441,7 @@ declare namespace Office {
|
|
|
15441
15441
|
* More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}.
|
|
15442
15442
|
*
|
|
15443
15443
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15444
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15444
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15445
15445
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
15446
15446
|
* of type `Office.AsyncResult`.
|
|
15447
15447
|
* On success, the initialization context data is provided in the `asyncResult.value` property as a string.
|
|
@@ -15478,7 +15478,7 @@ declare namespace Office {
|
|
|
15478
15478
|
/**
|
|
15479
15479
|
* Asynchronously gets the ID of a saved item.
|
|
15480
15480
|
*
|
|
15481
|
-
* When invoked, this method returns the item ID via the callback
|
|
15481
|
+
* When invoked, this method returns the item ID via the callback function.
|
|
15482
15482
|
*
|
|
15483
15483
|
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
|
|
15484
15484
|
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
@@ -15496,7 +15496,7 @@ declare namespace Office {
|
|
|
15496
15496
|
* - `ItemNotSaved`: The id can't be retrieved until the item is saved.
|
|
15497
15497
|
*
|
|
15498
15498
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15499
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15499
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15500
15500
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
15501
15501
|
* of type `Office.AsyncResult`.
|
|
15502
15502
|
*/
|
|
@@ -15504,7 +15504,7 @@ declare namespace Office {
|
|
|
15504
15504
|
/**
|
|
15505
15505
|
* Asynchronously gets the ID of a saved item.
|
|
15506
15506
|
*
|
|
15507
|
-
* When invoked, this method returns the item ID via the callback
|
|
15507
|
+
* When invoked, this method returns the item ID via the callback function.
|
|
15508
15508
|
*
|
|
15509
15509
|
* **Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use with EWS or the REST API),
|
|
15510
15510
|
* be aware that when Outlook is in cached mode, it may take some time before the item is synced to the server.
|
|
@@ -15531,7 +15531,7 @@ declare namespace Office {
|
|
|
15531
15531
|
* If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data.
|
|
15532
15532
|
* If a field other than the body or subject is selected, the method returns the `InvalidSelection` error.
|
|
15533
15533
|
*
|
|
15534
|
-
* To access the selected data from the callback
|
|
15534
|
+
* To access the selected data from the callback function, call `asyncResult.value.data`.
|
|
15535
15535
|
* To access the source property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`.
|
|
15536
15536
|
*
|
|
15537
15537
|
* @returns
|
|
@@ -15547,7 +15547,7 @@ declare namespace Office {
|
|
|
15547
15547
|
* @param coercionType - Requests a format for the data. If `Text`, the method returns the plain text as a string, removing any HTML tags present.
|
|
15548
15548
|
* If `Html`, the method returns the selected text, whether it is plaintext or HTML.
|
|
15549
15549
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15550
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15550
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15551
15551
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15552
15552
|
* type `Office.AsyncResult`.
|
|
15553
15553
|
*/
|
|
@@ -15558,7 +15558,7 @@ declare namespace Office {
|
|
|
15558
15558
|
* If there is no selection but the cursor is in the body or subject, the method returns an empty string for the selected data.
|
|
15559
15559
|
* If a field other than the body or subject is selected, the method returns the `InvalidSelection` error.
|
|
15560
15560
|
*
|
|
15561
|
-
* To access the selected data from the callback
|
|
15561
|
+
* To access the selected data from the callback function, call `asyncResult.value.data`.
|
|
15562
15562
|
* To access the source property that the selection comes from, call `asyncResult.value.sourceProperty`, which will be either `body` or `subject`.
|
|
15563
15563
|
*
|
|
15564
15564
|
* @returns
|
|
@@ -15614,7 +15614,7 @@ declare namespace Office {
|
|
|
15614
15614
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15615
15615
|
*
|
|
15616
15616
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15617
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15617
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15618
15618
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15619
15619
|
* type `Office.AsyncResult`. The `value` property of the result is the properties of the shared item.
|
|
15620
15620
|
*/
|
|
@@ -15675,7 +15675,7 @@ declare namespace Office {
|
|
|
15675
15675
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15676
15676
|
*
|
|
15677
15677
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15678
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15678
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15679
15679
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15680
15680
|
* type `Office.AsyncResult`.
|
|
15681
15681
|
*/
|
|
@@ -15745,7 +15745,7 @@ declare namespace Office {
|
|
|
15745
15745
|
* @param attachmentId - The identifier of the attachment to remove. The maximum string length of the `attachmentId`
|
|
15746
15746
|
* is 200 characters in Outlook on the web and on Windows.
|
|
15747
15747
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15748
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15748
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15749
15749
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15750
15750
|
* type `Office.AsyncResult`. If removing the attachment fails, the `asyncResult.error` property will contain an error code
|
|
15751
15751
|
* with the reason for the failure.
|
|
@@ -15793,7 +15793,7 @@ declare namespace Office {
|
|
|
15793
15793
|
*
|
|
15794
15794
|
* @param eventType - The event that should revoke the handler.
|
|
15795
15795
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15796
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15796
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15797
15797
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
15798
15798
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
15799
15799
|
*/
|
|
@@ -15819,7 +15819,7 @@ declare namespace Office {
|
|
|
15819
15819
|
/**
|
|
15820
15820
|
* Asynchronously saves an item.
|
|
15821
15821
|
*
|
|
15822
|
-
* When invoked, this method saves the current message as a draft and returns the item ID via the callback
|
|
15822
|
+
* When invoked, this method saves the current message as a draft and returns the item ID via the callback function.
|
|
15823
15823
|
* In Outlook on the web or Outlook in online mode, the item is saved to the server.
|
|
15824
15824
|
* In Outlook in cached mode, the item is saved to the local cache.
|
|
15825
15825
|
*
|
|
@@ -15846,7 +15846,7 @@ declare namespace Office {
|
|
|
15846
15846
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
15847
15847
|
*
|
|
15848
15848
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15849
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15849
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15850
15850
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15851
15851
|
* type `Office.AsyncResult`.
|
|
15852
15852
|
*/
|
|
@@ -15854,7 +15854,7 @@ declare namespace Office {
|
|
|
15854
15854
|
/**
|
|
15855
15855
|
* Asynchronously saves an item.
|
|
15856
15856
|
*
|
|
15857
|
-
* When invoked, this method saves the current message as a draft and returns the item id via the callback
|
|
15857
|
+
* When invoked, this method saves the current message as a draft and returns the item id via the callback function.
|
|
15858
15858
|
* In Outlook on the web or Outlook in online mode, the item is saved to the server.
|
|
15859
15859
|
* In Outlook in cached mode, the item is saved to the local cache.
|
|
15860
15860
|
*
|
|
@@ -15905,7 +15905,7 @@ declare namespace Office {
|
|
|
15905
15905
|
* @param data - The data to be inserted. Data is not to exceed 1,000,000 characters.
|
|
15906
15906
|
* If more than 1,000,000 characters are passed in, an `ArgumentOutOfRange` exception is thrown.
|
|
15907
15907
|
* @param options - An object literal that contains one or more of the following properties.
|
|
15908
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
15908
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
15909
15909
|
* `coercionType`: If text, the current style is applied in Outlook on the web and desktop clients.
|
|
15910
15910
|
* If the field is an HTML editor, only the text data is inserted, even if the data is HTML.
|
|
15911
15911
|
* If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook on the web and the default style is
|
|
@@ -16330,7 +16330,7 @@ declare namespace Office {
|
|
|
16330
16330
|
* @param handler - The function to handle the event. The function must accept a single parameter, which is an object literal.
|
|
16331
16331
|
* The `type` property on the parameter will match the eventType `parameter` passed to `addHandlerAsync`.
|
|
16332
16332
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16333
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16333
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16334
16334
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16335
16335
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16336
16336
|
*/
|
|
@@ -16401,7 +16401,7 @@ declare namespace Office {
|
|
|
16401
16401
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
16402
16402
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
16403
16403
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16404
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16404
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16405
16405
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16406
16406
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16407
16407
|
*/
|
|
@@ -16476,7 +16476,7 @@ declare namespace Office {
|
|
|
16476
16476
|
* @param formData - A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB
|
|
16477
16477
|
* OR a {@link Office.ReplyFormData | ReplyFormData} object that contains body or attachment data and a callback function.
|
|
16478
16478
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16479
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16479
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16480
16480
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16481
16481
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16482
16482
|
*/
|
|
@@ -16520,7 +16520,7 @@ declare namespace Office {
|
|
|
16520
16520
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16521
16521
|
*
|
|
16522
16522
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16523
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16523
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16524
16524
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16525
16525
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16526
16526
|
* On success, the internet headers data is provided in the `asyncResult.value` property as a string.
|
|
@@ -16573,7 +16573,7 @@ declare namespace Office {
|
|
|
16573
16573
|
*
|
|
16574
16574
|
* @param attachmentId - The identifier of the attachment you want to get.
|
|
16575
16575
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16576
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16576
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16577
16577
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16578
16578
|
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
16579
16579
|
* an error code with the reason for the failure.
|
|
@@ -16623,7 +16623,7 @@ declare namespace Office {
|
|
|
16623
16623
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16624
16624
|
*
|
|
16625
16625
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16626
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16626
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16627
16627
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
16628
16628
|
* of type `Office.AsyncResult`.
|
|
16629
16629
|
* On success, the initialization context data is provided in the `asyncResult.value` property as a string.
|
|
@@ -16866,7 +16866,7 @@ declare namespace Office {
|
|
|
16866
16866
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
16867
16867
|
*
|
|
16868
16868
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16869
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16869
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16870
16870
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16871
16871
|
* type `Office.AsyncResult`. The `value` property of the result is the properties of the shared item.
|
|
16872
16872
|
*/
|
|
@@ -16927,7 +16927,7 @@ declare namespace Office {
|
|
|
16927
16927
|
*
|
|
16928
16928
|
* @param eventType - The event that should revoke the handler.
|
|
16929
16929
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16930
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16930
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16931
16931
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16932
16932
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
16933
16933
|
*/
|
|
@@ -16975,7 +16975,7 @@ declare namespace Office {
|
|
|
16975
16975
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
16976
16976
|
*
|
|
16977
16977
|
* @param options - An object literal that contains one or more of the following properties.
|
|
16978
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
16978
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16979
16979
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16980
16980
|
* type `Office.AsyncResult`.
|
|
16981
16981
|
*
|
|
@@ -17013,7 +17013,7 @@ declare namespace Office {
|
|
|
17013
17013
|
*
|
|
17014
17014
|
* @param isAllDayEvent - boolean value to set the all day event status.
|
|
17015
17015
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17016
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17016
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17017
17017
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17018
17018
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
17019
17019
|
*
|
|
@@ -17176,7 +17176,7 @@ declare namespace Office {
|
|
|
17176
17176
|
* @param JSONmessage - A JSON object that contains the notification message to be added to the item.
|
|
17177
17177
|
* It contains a `NotificationMessageDetails` object.
|
|
17178
17178
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17179
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17179
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17180
17180
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
17181
17181
|
* of type `Office.AsyncResult`.
|
|
17182
17182
|
*/
|
|
@@ -17219,7 +17219,7 @@ declare namespace Office {
|
|
|
17219
17219
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
17220
17220
|
*
|
|
17221
17221
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17222
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17222
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17223
17223
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
17224
17224
|
* of type `Office.AsyncResult`. The `value` property of the result is an array of `NotificationMessageDetails` objects.
|
|
17225
17225
|
*/
|
|
@@ -17250,7 +17250,7 @@ declare namespace Office {
|
|
|
17250
17250
|
*
|
|
17251
17251
|
* @param key - The key for the notification message to remove.
|
|
17252
17252
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17253
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17253
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17254
17254
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
17255
17255
|
* of type `Office.AsyncResult`.
|
|
17256
17256
|
*/
|
|
@@ -17286,7 +17286,7 @@ declare namespace Office {
|
|
|
17286
17286
|
* @param JSONmessage - A JSON object that contains the new notification message to replace the existing message.
|
|
17287
17287
|
* It contains a `NotificationMessageDetails` object.
|
|
17288
17288
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17289
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17289
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17290
17290
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
17291
17291
|
* of type `Office.AsyncResult`.
|
|
17292
17292
|
*/
|
|
@@ -17366,7 +17366,7 @@ declare namespace Office {
|
|
|
17366
17366
|
* The appointment organizer is always a user whose email address is on the Exchange server.
|
|
17367
17367
|
*
|
|
17368
17368
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17369
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17369
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17370
17370
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17371
17371
|
* `asyncResult`, which is an `AsyncResult` object. The `value` property of the result is the appointment's organizer value,
|
|
17372
17372
|
* as an `EmailAddressDetails` object.
|
|
@@ -17463,7 +17463,7 @@ declare namespace Office {
|
|
|
17463
17463
|
*
|
|
17464
17464
|
* @param recipients - The recipients to add to the recipients list.
|
|
17465
17465
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17466
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17466
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17467
17467
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
17468
17468
|
* of type `Office.AsyncResult`. If adding the recipients fails, the `asyncResult.error` property will contain an error code.
|
|
17469
17469
|
*/
|
|
@@ -17540,7 +17540,7 @@ declare namespace Office {
|
|
|
17540
17540
|
* the auto-complete list.
|
|
17541
17541
|
*
|
|
17542
17542
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17543
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17543
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17544
17544
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
17545
17545
|
* of type `Office.AsyncResult`. The `value` property of the result is an array of `EmailAddressDetails` objects.
|
|
17546
17546
|
*/
|
|
@@ -17619,7 +17619,7 @@ declare namespace Office {
|
|
|
17619
17619
|
*
|
|
17620
17620
|
* @param recipients - The recipients to add to the recipients list.
|
|
17621
17621
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17622
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17622
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17623
17623
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
17624
17624
|
* type `Office.AsyncResult`. If setting the recipients fails the `asyncResult.error` property will contain a code that
|
|
17625
17625
|
* indicates any error that occurred while adding the data.
|
|
@@ -17850,7 +17850,7 @@ declare namespace Office {
|
|
|
17850
17850
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
17851
17851
|
*
|
|
17852
17852
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17853
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17853
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17854
17854
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17855
17855
|
* `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object.
|
|
17856
17856
|
*/
|
|
@@ -17889,7 +17889,7 @@ declare namespace Office {
|
|
|
17889
17889
|
*
|
|
17890
17890
|
* @param recurrencePattern - A recurrence object.
|
|
17891
17891
|
* @param options - An object literal that contains one or more of the following properties.
|
|
17892
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
17892
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
17893
17893
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
17894
17894
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
17895
17895
|
*/
|
|
@@ -18048,7 +18048,7 @@ declare namespace Office {
|
|
|
18048
18048
|
callback?: (asyncResult: Office.AsyncResult<any>) => void;
|
|
18049
18049
|
/**
|
|
18050
18050
|
* An object literal that contains the following property.
|
|
18051
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18051
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18052
18052
|
*/
|
|
18053
18053
|
options?: Office.AsyncContextOptions;
|
|
18054
18054
|
}
|
|
@@ -18132,7 +18132,7 @@ declare namespace Office {
|
|
|
18132
18132
|
*
|
|
18133
18133
|
* A maximum of 32KB is available for the settings of each add-in.
|
|
18134
18134
|
*
|
|
18135
|
-
* Any changes made to settings using the set
|
|
18135
|
+
* Any changes made to settings using the `set` method will not be saved to the server until the `saveAsync` method is called.
|
|
18136
18136
|
*
|
|
18137
18137
|
* @remarks
|
|
18138
18138
|
*
|
|
@@ -18169,7 +18169,7 @@ declare namespace Office {
|
|
|
18169
18169
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18170
18170
|
*
|
|
18171
18171
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18172
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18172
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18173
18173
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
18174
18174
|
* type `Office.AsyncResult`.
|
|
18175
18175
|
*
|
|
@@ -18204,7 +18204,7 @@ declare namespace Office {
|
|
|
18204
18204
|
*
|
|
18205
18205
|
* @param sensitivity - The sensitivity value as enum or string.
|
|
18206
18206
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18207
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18207
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18208
18208
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18209
18209
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
18210
18210
|
*
|
|
@@ -18426,7 +18426,7 @@ declare namespace Office {
|
|
|
18426
18426
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18427
18427
|
*
|
|
18428
18428
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18429
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18429
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18430
18430
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18431
18431
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
18432
18432
|
*/
|
|
@@ -18486,7 +18486,7 @@ declare namespace Office {
|
|
|
18486
18486
|
*
|
|
18487
18487
|
* @param name - The session data key.
|
|
18488
18488
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18489
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18489
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18490
18490
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18491
18491
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
18492
18492
|
*/
|
|
@@ -18521,7 +18521,7 @@ declare namespace Office {
|
|
|
18521
18521
|
* @param name - The session data key.
|
|
18522
18522
|
* @param value - The session data value as a string.
|
|
18523
18523
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18524
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18524
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18525
18525
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
18526
18526
|
* type `Office.AsyncResult`.
|
|
18527
18527
|
*/
|
|
@@ -18608,7 +18608,7 @@ declare namespace Office {
|
|
|
18608
18608
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18609
18609
|
*
|
|
18610
18610
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18611
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18611
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18612
18612
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
18613
18613
|
* of type `Office.AsyncResult`. The `value` property of the result is the subject of the item.
|
|
18614
18614
|
*/
|
|
@@ -18648,7 +18648,7 @@ declare namespace Office {
|
|
|
18648
18648
|
*
|
|
18649
18649
|
* @param subject - The subject of the appointment or message. The string is limited to 255 characters.
|
|
18650
18650
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18651
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18651
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18652
18652
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
18653
18653
|
* of type `Office.AsyncResult`. If setting the subject fails, the `asyncResult.error` property will contain an error code.
|
|
18654
18654
|
*/
|
|
@@ -18723,7 +18723,7 @@ declare namespace Office {
|
|
|
18723
18723
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18724
18724
|
*
|
|
18725
18725
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18726
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18726
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18727
18727
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
18728
18728
|
* of type `Office.AsyncResult`. The `value` property of the result is a `Date` object.
|
|
18729
18729
|
*/
|
|
@@ -18753,7 +18753,7 @@ declare namespace Office {
|
|
|
18753
18753
|
*
|
|
18754
18754
|
* The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method.
|
|
18755
18755
|
*
|
|
18756
|
-
* **Important**: In the Windows client, you can't use this
|
|
18756
|
+
* **Important**: In the Windows client, you can't use this method to update the start or end of a recurrence.
|
|
18757
18757
|
*
|
|
18758
18758
|
* @remarks
|
|
18759
18759
|
* [Api set: Mailbox 1.1]
|
|
@@ -18768,7 +18768,7 @@ declare namespace Office {
|
|
|
18768
18768
|
*
|
|
18769
18769
|
* @param dateTime - A date-time object in Coordinated Universal Time (UTC).
|
|
18770
18770
|
* @param options - An object literal that contains one or more of the following properties.
|
|
18771
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback
|
|
18771
|
+
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18772
18772
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
18773
18773
|
* type `Office.AsyncResult`. If setting the date and time fails, the `asyncResult.error` property will contain an error code.
|
|
18774
18774
|
*/
|
|
@@ -18781,7 +18781,7 @@ declare namespace Office {
|
|
|
18781
18781
|
*
|
|
18782
18782
|
* The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method.
|
|
18783
18783
|
*
|
|
18784
|
-
* **Important**: In the Windows client, you can't use this
|
|
18784
|
+
* **Important**: In the Windows client, you can't use this method to update the start or end of a recurrence.
|
|
18785
18785
|
*
|
|
18786
18786
|
* @remarks
|
|
18787
18787
|
* [Api set: Mailbox 1.1]
|
|
@@ -19644,7 +19644,24 @@ declare namespace Excel {
|
|
|
19644
19644
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19645
19645
|
* @beta
|
|
19646
19646
|
*/
|
|
19647
|
-
lambdaInCell = "LambdaInCell"
|
|
19647
|
+
lambdaInCell = "LambdaInCell",
|
|
19648
|
+
/**
|
|
19649
|
+
* An error caused by a `CellValue` object that is too deeply nested within another `CellValue`. Displays as error type #CALC! in Excel.
|
|
19650
|
+
*
|
|
19651
|
+
* @remarks
|
|
19652
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19653
|
+
* @beta
|
|
19654
|
+
*/
|
|
19655
|
+
tooDeeplyNested = "TooDeeplyNested",
|
|
19656
|
+
/**
|
|
19657
|
+
* An error caused by a cell's formula returning a string that exceeds the maximum of 32767 characters. Displays as error type #CALC! in Excel.
|
|
19658
|
+
* Some characters, like emoji, may appear to be one character in the Excel UI but are actually processed as surrogate characters. A surrogate character counts as multiple characters toward the maximum character limit.
|
|
19659
|
+
*
|
|
19660
|
+
* @remarks
|
|
19661
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19662
|
+
* @beta
|
|
19663
|
+
*/
|
|
19664
|
+
textOverflow = "TextOverflow"
|
|
19648
19665
|
}
|
|
19649
19666
|
/**
|
|
19650
19667
|
* Represents the value of a cell containing a #CALC! error.
|
|
@@ -19695,7 +19712,15 @@ declare namespace Excel {
|
|
|
19695
19712
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19696
19713
|
* @beta
|
|
19697
19714
|
*/
|
|
19698
|
-
errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell";
|
|
19715
|
+
errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell" | "TooDeeplyNested" | "TextOverflow";
|
|
19716
|
+
/**
|
|
19717
|
+
* Represents the name of the function causing the error.
|
|
19718
|
+
*
|
|
19719
|
+
* @remarks
|
|
19720
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19721
|
+
* @beta
|
|
19722
|
+
*/
|
|
19723
|
+
functionName?: string;
|
|
19699
19724
|
}
|
|
19700
19725
|
/**
|
|
19701
19726
|
* Represents a reference to a property used by the card layout.
|
|
@@ -19706,7 +19731,7 @@ declare namespace Excel {
|
|
|
19706
19731
|
*/
|
|
19707
19732
|
interface CardLayoutPropertyReference {
|
|
19708
19733
|
/**
|
|
19709
|
-
*
|
|
19734
|
+
* Represents the name of the property referenced by the card layout.
|
|
19710
19735
|
*
|
|
19711
19736
|
* @remarks
|
|
19712
19737
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -20838,6 +20863,14 @@ declare namespace Excel {
|
|
|
20838
20863
|
*/
|
|
20839
20864
|
div0 = "Div0",
|
|
20840
20865
|
/**
|
|
20866
|
+
* Represents an `ExternalErrorCellValue`.
|
|
20867
|
+
*
|
|
20868
|
+
* @remarks
|
|
20869
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20870
|
+
* @beta
|
|
20871
|
+
*/
|
|
20872
|
+
external = "External",
|
|
20873
|
+
/**
|
|
20841
20874
|
* Represents a `FieldErrorCellValue`.
|
|
20842
20875
|
*
|
|
20843
20876
|
* @remarks
|
|
@@ -20925,7 +20958,83 @@ declare namespace Excel {
|
|
|
20925
20958
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20926
20959
|
* @beta
|
|
20927
20960
|
*/
|
|
20928
|
-
type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | PlaceholderErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
|
|
20961
|
+
type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | ExternalErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | PlaceholderErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
|
|
20962
|
+
/**
|
|
20963
|
+
* Represents types of #EXTERNAL! errors.
|
|
20964
|
+
*
|
|
20965
|
+
* @remarks
|
|
20966
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20967
|
+
* @beta
|
|
20968
|
+
*/
|
|
20969
|
+
enum ExternalErrorCellValueSubType {
|
|
20970
|
+
/**
|
|
20971
|
+
* An unknown type of error. Displays as error type #EXTERNAL! in Excel.
|
|
20972
|
+
*
|
|
20973
|
+
* @remarks
|
|
20974
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20975
|
+
* @beta
|
|
20976
|
+
*/
|
|
20977
|
+
unknown = "Unknown",
|
|
20978
|
+
/**
|
|
20979
|
+
* An error returned by the Python interpreter as a result of running the Python code. Displays as error type #EXTERNAL! in Excel.
|
|
20980
|
+
*
|
|
20981
|
+
* @remarks
|
|
20982
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20983
|
+
* @beta
|
|
20984
|
+
*/
|
|
20985
|
+
pythonError = "PythonError"
|
|
20986
|
+
}
|
|
20987
|
+
/**
|
|
20988
|
+
* Represents the value of a cell containing an #EXTERNAL! error.
|
|
20989
|
+
*
|
|
20990
|
+
* @remarks
|
|
20991
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20992
|
+
* @beta
|
|
20993
|
+
*/
|
|
20994
|
+
interface ExternalErrorCellValue {
|
|
20995
|
+
/**
|
|
20996
|
+
* Represents the type of this cell value.
|
|
20997
|
+
*
|
|
20998
|
+
* @remarks
|
|
20999
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21000
|
+
* @beta
|
|
21001
|
+
*/
|
|
21002
|
+
type: CellValueType.error | "Error";
|
|
21003
|
+
/**
|
|
21004
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
21005
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
21006
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
21007
|
+
*
|
|
21008
|
+
* @remarks
|
|
21009
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21010
|
+
* @beta
|
|
21011
|
+
*/
|
|
21012
|
+
basicValue?: "#EXTERNAL!" | string;
|
|
21013
|
+
/**
|
|
21014
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
21015
|
+
*
|
|
21016
|
+
* @remarks
|
|
21017
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21018
|
+
* @beta
|
|
21019
|
+
*/
|
|
21020
|
+
basicType?: RangeValueType.error | "Error";
|
|
21021
|
+
/**
|
|
21022
|
+
* Represents the type of `ErrorCellValue`.
|
|
21023
|
+
*
|
|
21024
|
+
* @remarks
|
|
21025
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21026
|
+
* @beta
|
|
21027
|
+
*/
|
|
21028
|
+
errorType?: ErrorCellValueType.external | "External";
|
|
21029
|
+
/**
|
|
21030
|
+
* Represents the type of `ExternalErrorCellValue`.
|
|
21031
|
+
*
|
|
21032
|
+
* @remarks
|
|
21033
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21034
|
+
* @beta
|
|
21035
|
+
*/
|
|
21036
|
+
errorSubType?: ExternalErrorCellValueSubType | "Unknown" | "PythonError";
|
|
21037
|
+
}
|
|
20929
21038
|
/**
|
|
20930
21039
|
* Represents types of #FIELD! errors.
|
|
20931
21040
|
*
|
|
@@ -21009,6 +21118,14 @@ declare namespace Excel {
|
|
|
21009
21118
|
* @beta
|
|
21010
21119
|
*/
|
|
21011
21120
|
errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError";
|
|
21121
|
+
/**
|
|
21122
|
+
* Represents the field which was not found by FIELDVALUE.
|
|
21123
|
+
*
|
|
21124
|
+
* @remarks
|
|
21125
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21126
|
+
* @beta
|
|
21127
|
+
*/
|
|
21128
|
+
fieldName?: string;
|
|
21012
21129
|
}
|
|
21013
21130
|
/**
|
|
21014
21131
|
* Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
@@ -21350,6 +21467,31 @@ declare namespace Excel {
|
|
|
21350
21467
|
errorType?: ErrorCellValueType.null | "Null";
|
|
21351
21468
|
}
|
|
21352
21469
|
/**
|
|
21470
|
+
* Represents types of #NUM! errors.
|
|
21471
|
+
*
|
|
21472
|
+
* @remarks
|
|
21473
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21474
|
+
* @beta
|
|
21475
|
+
*/
|
|
21476
|
+
enum NumErrorCellValueSubType {
|
|
21477
|
+
/**
|
|
21478
|
+
* An unknown type of error. Displays as error type #NUM! in Excel.
|
|
21479
|
+
*
|
|
21480
|
+
* @remarks
|
|
21481
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21482
|
+
* @beta
|
|
21483
|
+
*/
|
|
21484
|
+
unknown = "Unknown",
|
|
21485
|
+
/**
|
|
21486
|
+
* An error caused by a cell's formula having an array parameter with too many rows or columns. The maximum number of rows and columns in an array parameter is 1048576. Displays as error type #NUM! in Excel.
|
|
21487
|
+
*
|
|
21488
|
+
* @remarks
|
|
21489
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21490
|
+
* @beta
|
|
21491
|
+
*/
|
|
21492
|
+
arrayTooLarge = "ArrayTooLarge"
|
|
21493
|
+
}
|
|
21494
|
+
/**
|
|
21353
21495
|
* Represents the value of a cell containing a #NUM! error.
|
|
21354
21496
|
*
|
|
21355
21497
|
* @remarks
|
|
@@ -21391,6 +21533,22 @@ declare namespace Excel {
|
|
|
21391
21533
|
* @beta
|
|
21392
21534
|
*/
|
|
21393
21535
|
errorType?: ErrorCellValueType.num | "Num";
|
|
21536
|
+
/**
|
|
21537
|
+
* Represents the type of `NumErrorCellValue`.
|
|
21538
|
+
*
|
|
21539
|
+
* @remarks
|
|
21540
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21541
|
+
* @beta
|
|
21542
|
+
*/
|
|
21543
|
+
errorSubType?: NumErrorCellValueSubType | "Unknown" | "ArrayTooLarge";
|
|
21544
|
+
/**
|
|
21545
|
+
* Represents the name of the function causing the error.
|
|
21546
|
+
*
|
|
21547
|
+
* @remarks
|
|
21548
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
21549
|
+
* @beta
|
|
21550
|
+
*/
|
|
21551
|
+
functionName?: string;
|
|
21394
21552
|
}
|
|
21395
21553
|
/**
|
|
21396
21554
|
* Represents types of #REF! errors.
|
|
@@ -32825,6 +32983,19 @@ declare namespace Excel {
|
|
|
32825
32983
|
* @param name Optional. Specifies the name of the new column. If `null`, the default name will be used.
|
|
32826
32984
|
*/
|
|
32827
32985
|
add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string): Excel.TableColumn;
|
|
32986
|
+
/**
|
|
32987
|
+
* Adds a new column to the table.
|
|
32988
|
+
Unlike `add()`, `addAsJson()` takes any type of cell value, such as image or entity data types.
|
|
32989
|
+
*
|
|
32990
|
+
* @remarks
|
|
32991
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
32992
|
+
* @beta
|
|
32993
|
+
*
|
|
32994
|
+
* @param index Optional. Specifies the relative position of the new column. If null or -1, the addition happens at the end. Columns with a higher index will be shifted to the side. Zero-indexed.
|
|
32995
|
+
* @param values Optional. A 2D array of cell values of the table column.
|
|
32996
|
+
* @param name Optional. Specifies the name of the new column. If `null`, the default name will be used.
|
|
32997
|
+
*/
|
|
32998
|
+
addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;
|
|
32828
32999
|
/**
|
|
32829
33000
|
* Gets the number of columns in the table.
|
|
32830
33001
|
*
|
|
@@ -33058,6 +33229,24 @@ declare namespace Excel {
|
|
|
33058
33229
|
* @param alwaysInsert Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`.
|
|
33059
33230
|
*/
|
|
33060
33231
|
add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;
|
|
33232
|
+
/**
|
|
33233
|
+
* Adds one or more rows to the table. The returned object will be the top row of the newly added row or rows.
|
|
33234
|
+
Unlike `add()`, `addAsJson()` takes any type of cell value, such as image or entity data types.
|
|
33235
|
+
|
|
33236
|
+
Note that unlike ranges or columns, which will adjust if new rows or columns are added before them,
|
|
33237
|
+
a `TableRow` object represents the physical location of the table row, but not the data.
|
|
33238
|
+
That is, if the data is sorted or if new rows are added, a table row will continue
|
|
33239
|
+
to point at the index for which it was created.
|
|
33240
|
+
*
|
|
33241
|
+
* @remarks
|
|
33242
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
33243
|
+
* @beta
|
|
33244
|
+
*
|
|
33245
|
+
* @param index Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
|
|
33246
|
+
* @param values Optional. A 2D array of cell values of the table row.
|
|
33247
|
+
* @param alwaysInsert Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`.
|
|
33248
|
+
*/
|
|
33249
|
+
addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean): Excel.TableRow;
|
|
33061
33250
|
/**
|
|
33062
33251
|
* Delete multiple rows from a table.
|
|
33063
33252
|
These rows don't need to be sequential. This method will throw the `InvalidArgument` error if a chosen row has already been deleted or doesn't exist.
|
|
@@ -83771,11 +83960,11 @@ declare namespace Word {
|
|
|
83771
83960
|
expand?: string;
|
|
83772
83961
|
}): Word.Body;
|
|
83773
83962
|
/**
|
|
83774
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
83963
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
83775
83964
|
*/
|
|
83776
83965
|
track(): Word.Body;
|
|
83777
83966
|
/**
|
|
83778
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
83967
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
83779
83968
|
*/
|
|
83780
83969
|
untrack(): Word.Body;
|
|
83781
83970
|
/**
|
|
@@ -83902,11 +84091,11 @@ declare namespace Word {
|
|
|
83902
84091
|
expand?: string;
|
|
83903
84092
|
}): Word.Comment;
|
|
83904
84093
|
/**
|
|
83905
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
84094
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
83906
84095
|
*/
|
|
83907
84096
|
track(): Word.Comment;
|
|
83908
84097
|
/**
|
|
83909
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
84098
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
83910
84099
|
*/
|
|
83911
84100
|
untrack(): Word.Comment;
|
|
83912
84101
|
/**
|
|
@@ -83968,11 +84157,11 @@ declare namespace Word {
|
|
|
83968
84157
|
*/
|
|
83969
84158
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection;
|
|
83970
84159
|
/**
|
|
83971
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
84160
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
83972
84161
|
*/
|
|
83973
84162
|
track(): Word.CommentCollection;
|
|
83974
84163
|
/**
|
|
83975
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
84164
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
83976
84165
|
*/
|
|
83977
84166
|
untrack(): Word.CommentCollection;
|
|
83978
84167
|
/**
|
|
@@ -84046,7 +84235,7 @@ declare namespace Word {
|
|
|
84046
84235
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
84047
84236
|
set(properties: Word.CommentContentRange): void;
|
|
84048
84237
|
/**
|
|
84049
|
-
* Inserts text into at the specified location.
|
|
84238
|
+
* Inserts text into at the specified location. **Note**: For the modern comment, the content range tracked across context turns to empty if any revision to the comment is posted through the UI.
|
|
84050
84239
|
*
|
|
84051
84240
|
* @remarks
|
|
84052
84241
|
* [Api set: WordApiOnline 1.1]
|
|
@@ -84056,7 +84245,7 @@ declare namespace Word {
|
|
|
84056
84245
|
*/
|
|
84057
84246
|
insertText(text: string, insertLocation: Word.InsertLocation): Word.CommentContentRange;
|
|
84058
84247
|
/**
|
|
84059
|
-
* Inserts text into at the specified location.
|
|
84248
|
+
* Inserts text into at the specified location. **Note**: For the modern comment, the content range tracked across context turns to empty if any revision to the comment is posted through the UI.
|
|
84060
84249
|
*
|
|
84061
84250
|
* @remarks
|
|
84062
84251
|
* [Api set: WordApiOnline 1.1]
|
|
@@ -84087,11 +84276,11 @@ declare namespace Word {
|
|
|
84087
84276
|
expand?: string;
|
|
84088
84277
|
}): Word.CommentContentRange;
|
|
84089
84278
|
/**
|
|
84090
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
84279
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84091
84280
|
*/
|
|
84092
84281
|
track(): Word.CommentContentRange;
|
|
84093
84282
|
/**
|
|
84094
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
84283
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
84095
84284
|
*/
|
|
84096
84285
|
untrack(): Word.CommentContentRange;
|
|
84097
84286
|
/**
|
|
@@ -84195,11 +84384,11 @@ declare namespace Word {
|
|
|
84195
84384
|
expand?: string;
|
|
84196
84385
|
}): Word.CommentReply;
|
|
84197
84386
|
/**
|
|
84198
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
84387
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84199
84388
|
*/
|
|
84200
84389
|
track(): Word.CommentReply;
|
|
84201
84390
|
/**
|
|
84202
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
84391
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
84203
84392
|
*/
|
|
84204
84393
|
untrack(): Word.CommentReply;
|
|
84205
84394
|
/**
|
|
@@ -84261,11 +84450,11 @@ declare namespace Word {
|
|
|
84261
84450
|
*/
|
|
84262
84451
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentReplyCollection;
|
|
84263
84452
|
/**
|
|
84264
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
84453
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84265
84454
|
*/
|
|
84266
84455
|
track(): Word.CommentReplyCollection;
|
|
84267
84456
|
/**
|
|
84268
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
84457
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
84269
84458
|
*/
|
|
84270
84459
|
untrack(): Word.CommentReplyCollection;
|
|
84271
84460
|
/**
|
|
@@ -84520,7 +84709,7 @@ declare namespace Word {
|
|
|
84520
84709
|
*/
|
|
84521
84710
|
delete(keepContent: boolean): void;
|
|
84522
84711
|
/**
|
|
84523
|
-
* Gets comments associated with the
|
|
84712
|
+
* Gets comments associated with the content control.
|
|
84524
84713
|
*
|
|
84525
84714
|
* @remarks
|
|
84526
84715
|
* [Api set: WordApiOnline 1.1]
|
|
@@ -84850,11 +85039,11 @@ declare namespace Word {
|
|
|
84850
85039
|
*/
|
|
84851
85040
|
readonly onSelectionChanged: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;
|
|
84852
85041
|
/**
|
|
84853
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
85042
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84854
85043
|
*/
|
|
84855
85044
|
track(): Word.ContentControl;
|
|
84856
85045
|
/**
|
|
84857
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
85046
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
84858
85047
|
*/
|
|
84859
85048
|
untrack(): Word.ContentControl;
|
|
84860
85049
|
/**
|
|
@@ -84961,11 +85150,11 @@ declare namespace Word {
|
|
|
84961
85150
|
*/
|
|
84962
85151
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ContentControlCollection;
|
|
84963
85152
|
/**
|
|
84964
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
85153
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
84965
85154
|
*/
|
|
84966
85155
|
track(): Word.ContentControlCollection;
|
|
84967
85156
|
/**
|
|
84968
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
85157
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
84969
85158
|
*/
|
|
84970
85159
|
untrack(): Word.ContentControlCollection;
|
|
84971
85160
|
/**
|
|
@@ -85041,11 +85230,11 @@ declare namespace Word {
|
|
|
85041
85230
|
expand?: string;
|
|
85042
85231
|
}): Word.CustomProperty;
|
|
85043
85232
|
/**
|
|
85044
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
85233
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
85045
85234
|
*/
|
|
85046
85235
|
track(): Word.CustomProperty;
|
|
85047
85236
|
/**
|
|
85048
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
85237
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
85049
85238
|
*/
|
|
85050
85239
|
untrack(): Word.CustomProperty;
|
|
85051
85240
|
/**
|
|
@@ -85126,11 +85315,11 @@ declare namespace Word {
|
|
|
85126
85315
|
*/
|
|
85127
85316
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomPropertyCollection;
|
|
85128
85317
|
/**
|
|
85129
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
85318
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
85130
85319
|
*/
|
|
85131
85320
|
track(): Word.CustomPropertyCollection;
|
|
85132
85321
|
/**
|
|
85133
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
85322
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
85134
85323
|
*/
|
|
85135
85324
|
untrack(): Word.CustomPropertyCollection;
|
|
85136
85325
|
/**
|
|
@@ -85418,11 +85607,11 @@ declare namespace Word {
|
|
|
85418
85607
|
expand?: string;
|
|
85419
85608
|
}): Word.CustomXmlPart;
|
|
85420
85609
|
/**
|
|
85421
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
85610
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
85422
85611
|
*/
|
|
85423
85612
|
track(): Word.CustomXmlPart;
|
|
85424
85613
|
/**
|
|
85425
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
85614
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
85426
85615
|
*/
|
|
85427
85616
|
untrack(): Word.CustomXmlPart;
|
|
85428
85617
|
/**
|
|
@@ -85510,11 +85699,11 @@ declare namespace Word {
|
|
|
85510
85699
|
*/
|
|
85511
85700
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPartCollection;
|
|
85512
85701
|
/**
|
|
85513
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
85702
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
85514
85703
|
*/
|
|
85515
85704
|
track(): Word.CustomXmlPartCollection;
|
|
85516
85705
|
/**
|
|
85517
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
85706
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
85518
85707
|
*/
|
|
85519
85708
|
untrack(): Word.CustomXmlPartCollection;
|
|
85520
85709
|
/**
|
|
@@ -85598,11 +85787,11 @@ declare namespace Word {
|
|
|
85598
85787
|
*/
|
|
85599
85788
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPartScopedCollection;
|
|
85600
85789
|
/**
|
|
85601
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
85790
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
85602
85791
|
*/
|
|
85603
85792
|
track(): Word.CustomXmlPartScopedCollection;
|
|
85604
85793
|
/**
|
|
85605
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
85794
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
85606
85795
|
*/
|
|
85607
85796
|
untrack(): Word.CustomXmlPartScopedCollection;
|
|
85608
85797
|
/**
|
|
@@ -85793,11 +85982,11 @@ declare namespace Word {
|
|
|
85793
85982
|
*/
|
|
85794
85983
|
readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;
|
|
85795
85984
|
/**
|
|
85796
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
85985
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
85797
85986
|
*/
|
|
85798
85987
|
track(): Word.Document;
|
|
85799
85988
|
/**
|
|
85800
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
85989
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
85801
85990
|
*/
|
|
85802
85991
|
untrack(): Word.Document;
|
|
85803
85992
|
/**
|
|
@@ -85940,11 +86129,11 @@ declare namespace Word {
|
|
|
85940
86129
|
expand?: string;
|
|
85941
86130
|
}): Word.DocumentCreated;
|
|
85942
86131
|
/**
|
|
85943
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
86132
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
85944
86133
|
*/
|
|
85945
86134
|
track(): Word.DocumentCreated;
|
|
85946
86135
|
/**
|
|
85947
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
86136
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
85948
86137
|
*/
|
|
85949
86138
|
untrack(): Word.DocumentCreated;
|
|
85950
86139
|
/**
|
|
@@ -86118,11 +86307,11 @@ declare namespace Word {
|
|
|
86118
86307
|
expand?: string;
|
|
86119
86308
|
}): Word.DocumentProperties;
|
|
86120
86309
|
/**
|
|
86121
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
86310
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
86122
86311
|
*/
|
|
86123
86312
|
track(): Word.DocumentProperties;
|
|
86124
86313
|
/**
|
|
86125
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
86314
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
86126
86315
|
*/
|
|
86127
86316
|
untrack(): Word.DocumentProperties;
|
|
86128
86317
|
/**
|
|
@@ -86267,11 +86456,11 @@ declare namespace Word {
|
|
|
86267
86456
|
expand?: string;
|
|
86268
86457
|
}): Word.Field;
|
|
86269
86458
|
/**
|
|
86270
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
86459
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
86271
86460
|
*/
|
|
86272
86461
|
track(): Word.Field;
|
|
86273
86462
|
/**
|
|
86274
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
86463
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
86275
86464
|
*/
|
|
86276
86465
|
untrack(): Word.Field;
|
|
86277
86466
|
/**
|
|
@@ -86327,11 +86516,11 @@ declare namespace Word {
|
|
|
86327
86516
|
*/
|
|
86328
86517
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection;
|
|
86329
86518
|
/**
|
|
86330
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
86519
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
86331
86520
|
*/
|
|
86332
86521
|
track(): Word.FieldCollection;
|
|
86333
86522
|
/**
|
|
86334
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
86523
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
86335
86524
|
*/
|
|
86336
86525
|
untrack(): Word.FieldCollection;
|
|
86337
86526
|
/**
|
|
@@ -86457,11 +86646,11 @@ declare namespace Word {
|
|
|
86457
86646
|
expand?: string;
|
|
86458
86647
|
}): Word.Font;
|
|
86459
86648
|
/**
|
|
86460
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
86649
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
86461
86650
|
*/
|
|
86462
86651
|
track(): Word.Font;
|
|
86463
86652
|
/**
|
|
86464
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
86653
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
86465
86654
|
*/
|
|
86466
86655
|
untrack(): Word.Font;
|
|
86467
86656
|
/**
|
|
@@ -86819,11 +87008,11 @@ declare namespace Word {
|
|
|
86819
87008
|
expand?: string;
|
|
86820
87009
|
}): Word.InlinePicture;
|
|
86821
87010
|
/**
|
|
86822
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
87011
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
86823
87012
|
*/
|
|
86824
87013
|
track(): Word.InlinePicture;
|
|
86825
87014
|
/**
|
|
86826
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
87015
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
86827
87016
|
*/
|
|
86828
87017
|
untrack(): Word.InlinePicture;
|
|
86829
87018
|
/**
|
|
@@ -86876,11 +87065,11 @@ declare namespace Word {
|
|
|
86876
87065
|
*/
|
|
86877
87066
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.InlinePictureCollection;
|
|
86878
87067
|
/**
|
|
86879
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
87068
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
86880
87069
|
*/
|
|
86881
87070
|
track(): Word.InlinePictureCollection;
|
|
86882
87071
|
/**
|
|
86883
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
87072
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
86884
87073
|
*/
|
|
86885
87074
|
untrack(): Word.InlinePictureCollection;
|
|
86886
87075
|
/**
|
|
@@ -87115,11 +87304,11 @@ declare namespace Word {
|
|
|
87115
87304
|
expand?: string;
|
|
87116
87305
|
}): Word.List;
|
|
87117
87306
|
/**
|
|
87118
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
87307
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
87119
87308
|
*/
|
|
87120
87309
|
track(): Word.List;
|
|
87121
87310
|
/**
|
|
87122
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
87311
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
87123
87312
|
*/
|
|
87124
87313
|
untrack(): Word.List;
|
|
87125
87314
|
/**
|
|
@@ -87199,11 +87388,11 @@ declare namespace Word {
|
|
|
87199
87388
|
*/
|
|
87200
87389
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListCollection;
|
|
87201
87390
|
/**
|
|
87202
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
87391
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
87203
87392
|
*/
|
|
87204
87393
|
track(): Word.ListCollection;
|
|
87205
87394
|
/**
|
|
87206
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
87395
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
87207
87396
|
*/
|
|
87208
87397
|
untrack(): Word.ListCollection;
|
|
87209
87398
|
/**
|
|
@@ -87299,11 +87488,11 @@ declare namespace Word {
|
|
|
87299
87488
|
expand?: string;
|
|
87300
87489
|
}): Word.ListItem;
|
|
87301
87490
|
/**
|
|
87302
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
87491
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
87303
87492
|
*/
|
|
87304
87493
|
track(): Word.ListItem;
|
|
87305
87494
|
/**
|
|
87306
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
87495
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
87307
87496
|
*/
|
|
87308
87497
|
untrack(): Word.ListItem;
|
|
87309
87498
|
/**
|
|
@@ -87393,11 +87582,11 @@ declare namespace Word {
|
|
|
87393
87582
|
expand?: string;
|
|
87394
87583
|
}): Word.NoteItem;
|
|
87395
87584
|
/**
|
|
87396
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
87585
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
87397
87586
|
*/
|
|
87398
87587
|
track(): Word.NoteItem;
|
|
87399
87588
|
/**
|
|
87400
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
87589
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
87401
87590
|
*/
|
|
87402
87591
|
untrack(): Word.NoteItem;
|
|
87403
87592
|
/**
|
|
@@ -87450,11 +87639,11 @@ declare namespace Word {
|
|
|
87450
87639
|
*/
|
|
87451
87640
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection;
|
|
87452
87641
|
/**
|
|
87453
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
87642
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
87454
87643
|
*/
|
|
87455
87644
|
track(): Word.NoteItemCollection;
|
|
87456
87645
|
/**
|
|
87457
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
87646
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
87458
87647
|
*/
|
|
87459
87648
|
untrack(): Word.NoteItemCollection;
|
|
87460
87649
|
/**
|
|
@@ -88085,11 +88274,11 @@ declare namespace Word {
|
|
|
88085
88274
|
expand?: string;
|
|
88086
88275
|
}): Word.Paragraph;
|
|
88087
88276
|
/**
|
|
88088
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
88277
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
88089
88278
|
*/
|
|
88090
88279
|
track(): Word.Paragraph;
|
|
88091
88280
|
/**
|
|
88092
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
88281
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
88093
88282
|
*/
|
|
88094
88283
|
untrack(): Word.Paragraph;
|
|
88095
88284
|
/**
|
|
@@ -88156,11 +88345,11 @@ declare namespace Word {
|
|
|
88156
88345
|
*/
|
|
88157
88346
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection;
|
|
88158
88347
|
/**
|
|
88159
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
88348
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
88160
88349
|
*/
|
|
88161
88350
|
track(): Word.ParagraphCollection;
|
|
88162
88351
|
/**
|
|
88163
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
88352
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
88164
88353
|
*/
|
|
88165
88354
|
untrack(): Word.ParagraphCollection;
|
|
88166
88355
|
/**
|
|
@@ -88778,11 +88967,11 @@ declare namespace Word {
|
|
|
88778
88967
|
expand?: string;
|
|
88779
88968
|
}): Word.Range;
|
|
88780
88969
|
/**
|
|
88781
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
88970
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
88782
88971
|
*/
|
|
88783
88972
|
track(): Word.Range;
|
|
88784
88973
|
/**
|
|
88785
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
88974
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
88786
88975
|
*/
|
|
88787
88976
|
untrack(): Word.Range;
|
|
88788
88977
|
/**
|
|
@@ -88835,11 +89024,11 @@ declare namespace Word {
|
|
|
88835
89024
|
*/
|
|
88836
89025
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeCollection;
|
|
88837
89026
|
/**
|
|
88838
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
89027
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
88839
89028
|
*/
|
|
88840
89029
|
track(): Word.RangeCollection;
|
|
88841
89030
|
/**
|
|
88842
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
89031
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
88843
89032
|
*/
|
|
88844
89033
|
untrack(): Word.RangeCollection;
|
|
88845
89034
|
/**
|
|
@@ -89043,11 +89232,11 @@ declare namespace Word {
|
|
|
89043
89232
|
expand?: string;
|
|
89044
89233
|
}): Word.Section;
|
|
89045
89234
|
/**
|
|
89046
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
89235
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
89047
89236
|
*/
|
|
89048
89237
|
track(): Word.Section;
|
|
89049
89238
|
/**
|
|
89050
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
89239
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
89051
89240
|
*/
|
|
89052
89241
|
untrack(): Word.Section;
|
|
89053
89242
|
/**
|
|
@@ -89100,11 +89289,11 @@ declare namespace Word {
|
|
|
89100
89289
|
*/
|
|
89101
89290
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SectionCollection;
|
|
89102
89291
|
/**
|
|
89103
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
89292
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
89104
89293
|
*/
|
|
89105
89294
|
track(): Word.SectionCollection;
|
|
89106
89295
|
/**
|
|
89107
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
89296
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
89108
89297
|
*/
|
|
89109
89298
|
untrack(): Word.SectionCollection;
|
|
89110
89299
|
/**
|
|
@@ -89177,11 +89366,11 @@ declare namespace Word {
|
|
|
89177
89366
|
expand?: string;
|
|
89178
89367
|
}): Word.Setting;
|
|
89179
89368
|
/**
|
|
89180
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
89369
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
89181
89370
|
*/
|
|
89182
89371
|
track(): Word.Setting;
|
|
89183
89372
|
/**
|
|
89184
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
89373
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
89185
89374
|
*/
|
|
89186
89375
|
untrack(): Word.Setting;
|
|
89187
89376
|
/**
|
|
@@ -89268,11 +89457,11 @@ declare namespace Word {
|
|
|
89268
89457
|
*/
|
|
89269
89458
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SettingCollection;
|
|
89270
89459
|
/**
|
|
89271
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
89460
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
89272
89461
|
*/
|
|
89273
89462
|
track(): Word.SettingCollection;
|
|
89274
89463
|
/**
|
|
89275
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
89464
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
89276
89465
|
*/
|
|
89277
89466
|
untrack(): Word.SettingCollection;
|
|
89278
89467
|
/**
|
|
@@ -89859,11 +90048,11 @@ declare namespace Word {
|
|
|
89859
90048
|
expand?: string;
|
|
89860
90049
|
}): Word.Table;
|
|
89861
90050
|
/**
|
|
89862
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
90051
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
89863
90052
|
*/
|
|
89864
90053
|
track(): Word.Table;
|
|
89865
90054
|
/**
|
|
89866
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
90055
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
89867
90056
|
*/
|
|
89868
90057
|
untrack(): Word.Table;
|
|
89869
90058
|
/**
|
|
@@ -89916,11 +90105,11 @@ declare namespace Word {
|
|
|
89916
90105
|
*/
|
|
89917
90106
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCollection;
|
|
89918
90107
|
/**
|
|
89919
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
90108
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
89920
90109
|
*/
|
|
89921
90110
|
track(): Word.TableCollection;
|
|
89922
90111
|
/**
|
|
89923
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
90112
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
89924
90113
|
*/
|
|
89925
90114
|
untrack(): Word.TableCollection;
|
|
89926
90115
|
/**
|
|
@@ -90225,11 +90414,11 @@ declare namespace Word {
|
|
|
90225
90414
|
expand?: string;
|
|
90226
90415
|
}): Word.TableRow;
|
|
90227
90416
|
/**
|
|
90228
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
90417
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
90229
90418
|
*/
|
|
90230
90419
|
track(): Word.TableRow;
|
|
90231
90420
|
/**
|
|
90232
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
90421
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
90233
90422
|
*/
|
|
90234
90423
|
untrack(): Word.TableRow;
|
|
90235
90424
|
/**
|
|
@@ -90282,11 +90471,11 @@ declare namespace Word {
|
|
|
90282
90471
|
*/
|
|
90283
90472
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection;
|
|
90284
90473
|
/**
|
|
90285
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
90474
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
90286
90475
|
*/
|
|
90287
90476
|
track(): Word.TableRowCollection;
|
|
90288
90477
|
/**
|
|
90289
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
90478
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
90290
90479
|
*/
|
|
90291
90480
|
untrack(): Word.TableRowCollection;
|
|
90292
90481
|
/**
|
|
@@ -90550,11 +90739,11 @@ declare namespace Word {
|
|
|
90550
90739
|
expand?: string;
|
|
90551
90740
|
}): Word.TableCell;
|
|
90552
90741
|
/**
|
|
90553
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
90742
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
90554
90743
|
*/
|
|
90555
90744
|
track(): Word.TableCell;
|
|
90556
90745
|
/**
|
|
90557
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
90746
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
90558
90747
|
*/
|
|
90559
90748
|
untrack(): Word.TableCell;
|
|
90560
90749
|
/**
|
|
@@ -90607,11 +90796,11 @@ declare namespace Word {
|
|
|
90607
90796
|
*/
|
|
90608
90797
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection;
|
|
90609
90798
|
/**
|
|
90610
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
90799
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
90611
90800
|
*/
|
|
90612
90801
|
track(): Word.TableCellCollection;
|
|
90613
90802
|
/**
|
|
90614
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
90803
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
90615
90804
|
*/
|
|
90616
90805
|
untrack(): Word.TableCellCollection;
|
|
90617
90806
|
/**
|
|
@@ -90680,11 +90869,11 @@ declare namespace Word {
|
|
|
90680
90869
|
expand?: string;
|
|
90681
90870
|
}): Word.TableBorder;
|
|
90682
90871
|
/**
|
|
90683
|
-
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for
|
|
90872
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
90684
90873
|
*/
|
|
90685
90874
|
track(): Word.TableBorder;
|
|
90686
90875
|
/**
|
|
90687
|
-
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
|
|
90876
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
|
|
90688
90877
|
*/
|
|
90689
90878
|
untrack(): Word.TableBorder;
|
|
90690
90879
|
/**
|
|
@@ -90756,54 +90945,40 @@ declare namespace Word {
|
|
|
90756
90945
|
endnote = "Endnote",
|
|
90757
90946
|
}
|
|
90758
90947
|
/**
|
|
90759
|
-
* Provides information about the type of a raised event.
|
|
90948
|
+
* Provides information about the type of a raised event.
|
|
90760
90949
|
*
|
|
90761
90950
|
* @remarks
|
|
90762
90951
|
* [Api set: WordApi 1.3]
|
|
90763
90952
|
*/
|
|
90764
90953
|
enum EventType {
|
|
90765
90954
|
/**
|
|
90766
|
-
* ContentControlDeleted
|
|
90955
|
+
* ContentControlDeleted represents the event that the content control has been deleted.
|
|
90767
90956
|
* @remarks
|
|
90768
|
-
* [Api set: WordApi
|
|
90957
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
90958
|
+
* @beta
|
|
90769
90959
|
*/
|
|
90770
90960
|
contentControlDeleted = "ContentControlDeleted",
|
|
90771
90961
|
/**
|
|
90772
90962
|
* ContentControlSelectionChanged represents the event that the selection in the content control has been changed.
|
|
90773
90963
|
* @remarks
|
|
90774
|
-
* [Api set: WordApi
|
|
90964
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
90965
|
+
* @beta
|
|
90775
90966
|
*/
|
|
90776
90967
|
contentControlSelectionChanged = "ContentControlSelectionChanged",
|
|
90777
90968
|
/**
|
|
90778
90969
|
* ContentControlDataChanged represents the event that the data in the content control have been changed.
|
|
90779
90970
|
* @remarks
|
|
90780
|
-
* [Api set: WordApi
|
|
90971
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
90972
|
+
* @beta
|
|
90781
90973
|
*/
|
|
90782
90974
|
contentControlDataChanged = "ContentControlDataChanged",
|
|
90783
90975
|
/**
|
|
90784
90976
|
* ContentControlAdded represents the event a content control has been added to the document.
|
|
90785
90977
|
* @remarks
|
|
90786
|
-
* [Api set: WordApi
|
|
90978
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
90979
|
+
* @beta
|
|
90787
90980
|
*/
|
|
90788
90981
|
contentControlAdded = "ContentControlAdded",
|
|
90789
|
-
/**
|
|
90790
|
-
* AnnotationAdded represents the event an annotation has been added to the document.
|
|
90791
|
-
* @remarks
|
|
90792
|
-
* [Api set: WordApi 1.3]
|
|
90793
|
-
*/
|
|
90794
|
-
annotationAdded = "AnnotationAdded",
|
|
90795
|
-
/**
|
|
90796
|
-
* AnnotationAdded represents the event an annotation has been updated in the document.
|
|
90797
|
-
* @remarks
|
|
90798
|
-
* [Api set: WordApi 1.3]
|
|
90799
|
-
*/
|
|
90800
|
-
annotationChanged = "AnnotationChanged",
|
|
90801
|
-
/**
|
|
90802
|
-
* AnnotationAdded represents the event an annotation has been deleted from the document.
|
|
90803
|
-
* @remarks
|
|
90804
|
-
* [Api set: WordApi 1.3]
|
|
90805
|
-
*/
|
|
90806
|
-
annotationDeleted = "AnnotationDeleted",
|
|
90807
90982
|
}
|
|
90808
90983
|
/**
|
|
90809
90984
|
* Provides information about the content control that raised an event.
|
|
@@ -90828,7 +91003,7 @@ declare namespace Word {
|
|
|
90828
91003
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
90829
91004
|
* @beta
|
|
90830
91005
|
*/
|
|
90831
|
-
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded"
|
|
91006
|
+
eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded";
|
|
90832
91007
|
}
|
|
90833
91008
|
/**
|
|
90834
91009
|
* Specifies supported content control types and subtypes.
|
|
@@ -91142,7 +91317,7 @@ declare namespace Word {
|
|
|
91142
91317
|
* @remarks
|
|
91143
91318
|
* [Api set: WordApi 1.1]
|
|
91144
91319
|
*
|
|
91145
|
-
* To be used with an API call, such as `obj.insertSomething(newStuff, location)
|
|
91320
|
+
* To be used with an API call, such as `obj.insertSomething(newStuff, location);`.
|
|
91146
91321
|
* If the location is "Before" or "After", the new content will be outside of the modified object.
|
|
91147
91322
|
* If the location is "Start" or "End", the new content will be included as part of the modified object.
|
|
91148
91323
|
*/
|
|
@@ -91225,7 +91400,7 @@ declare namespace Word {
|
|
|
91225
91400
|
*/
|
|
91226
91401
|
enum HeaderFooterType {
|
|
91227
91402
|
/**
|
|
91228
|
-
* Returns the header or footer on all pages of a section, but excludes the first page or
|
|
91403
|
+
* Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different.
|
|
91229
91404
|
* @remarks
|
|
91230
91405
|
* [Api set: WordApi 1.1]
|
|
91231
91406
|
*/
|