@types/office-js 1.0.577 → 1.0.578

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 24 Feb 2026 19:25:51 GMT
11
+ * Last updated: Wed, 25 Feb 2026 19:47:40 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -464,7 +464,7 @@ declare namespace Office {
464
464
  * Return a JSON object that contains an array of the IDs, titles, and indexes of the selected slides. For example,
465
465
  * `{"slides":[{"id":257,"title":"Slide 2","index":2},{"id":256,"title":"Slide 1","index":1}]}` for a selection of two slides.
466
466
  *
467
- * **Note**: Only applies to data in PowerPoint when calling the {@link Office.Document | Document}.getSelectedData method to get the current
467
+ * **Note**: Only applies to data in PowerPoint when calling the {@link Office.Document | Document}.getSelectedDataAsync method to get the current
468
468
  * slide or selected range of slides.
469
469
  */
470
470
  SlideRange,
@@ -607,7 +607,7 @@ declare namespace Office {
607
607
  /**
608
608
  * Occurs when data within the binding is changed in Excel or Word.
609
609
  *
610
- * To add an event handler for the `BindingDataChanged` event of a binding, use the `addHandlerAsync` method of the Binding object.
610
+ * To add an event handler for the `BindingDataChanged` event of a binding, use the `addHandlerAsync` method of the `Binding` object.
611
611
  * The event handler receives an argument of type {@link Office.BindingDataChangedEventArgs}.
612
612
  */
613
613
  BindingDataChanged,
@@ -615,7 +615,7 @@ declare namespace Office {
615
615
  * Occurs when the selection is changed within the binding in Excel or Word.
616
616
  *
617
617
  * To add an event handler for the `BindingSelectionChanged` event of a binding, use
618
- * the `addHandlerAsync` method of the Binding object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}.
618
+ * the `addHandlerAsync` method of the `Binding` object. The event handler receives an argument of type {@link Office.BindingSelectionChangedEventArgs}.
619
619
  */
620
620
  BindingSelectionChanged,
621
621
  /**
@@ -3227,7 +3227,7 @@ declare namespace Office {
3227
3227
  *
3228
3228
  * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
3229
3229
  *
3230
- * @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions (as defined in an manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}`.
3230
+ * @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions (as defined in a manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}`.
3231
3231
  */
3232
3232
  getShortcuts(): Promise<{[actionId: string]: string|null}>;
3233
3233
  /**
@@ -3376,6 +3376,8 @@ declare namespace Office {
3376
3376
  *
3377
3377
  * [Api set: Mailbox 1.3]
3378
3378
  *
3379
+ * See {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
3380
+ *
3379
3381
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
3380
3382
  *
3381
3383
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
@@ -3471,7 +3473,7 @@ declare namespace Office {
3471
3473
  *
3472
3474
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
3473
3475
  */
3474
- allowEvent: boolean;
3476
+ allowEvent?: boolean;
3475
3477
  }
3476
3478
  /**
3477
3479
  * Encapsulates source data for add-in events.
@@ -3485,6 +3487,8 @@ declare namespace Office {
3485
3487
  *
3486
3488
  * [Api set: Mailbox 1.3]
3487
3489
  *
3490
+ * See {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
3491
+ *
3488
3492
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
3489
3493
  *
3490
3494
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
@@ -3583,7 +3587,7 @@ declare namespace Office {
3583
3587
  value: T;
3584
3588
  }
3585
3589
  /**
3586
- * The Office Auth namespace, `Office.auth`, provides a method that allows the Office client application to obtain an access token to the add-in's web application.
3590
+ * The Office Auth namespace, `Office.auth`, provides methods for the Office client application to obtain access tokens to the add-in's web application.
3587
3591
  * Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.
3588
3592
  */
3589
3593
  interface Auth {
@@ -4044,7 +4048,7 @@ declare namespace Office {
4044
4048
  * </tr>
4045
4049
  * <tr>
4046
4050
  * <td>A string</td>
4047
- * <td>The specified text is inserted as the value of the first bound cell. You can also specify a valid formula to add that formula to the bound cell. For example, setting data to <code>"=SUM(A1:A5)"</code> will total the values in the specified range. However, when you set a formula on the bound cell, after doing so, you can't read the added formula (or any pre-existing formula) from the bound cell. If you call the Binding.getDataAsync method on the bound cell to read its data, the method can return only the data displayed in the cell (the formula's result).</td>
4051
+ * <td>The specified text is inserted as the value of the first bound cell. You can also specify a valid formula to add that formula to the bound cell. For example, setting data to <code>"=SUM(A1:A5)"</code> will total the values in the specified range. However, when you set a formula on the bound cell, after doing so, you can't read the added formula (or any pre-existing formula) from the bound cell. If you call the <code>Binding.getDataAsync</code> method on the bound cell to read its data, the method can return only the data displayed in the cell (the formula's result).</td>
4048
4052
  * </tr>
4049
4053
  * <tr>
4050
4054
  * <td>An array of arrays ("matrix"), and the shape exactly matches the shape of the binding specified</td>
@@ -4096,7 +4100,7 @@ declare namespace Office {
4096
4100
  *
4097
4101
  * @param data The data to be set in the current selection. Possible data types by Office application:
4098
4102
  *
4099
- * string: Excel on the web and Windows, and Word on the web and on Windows only
4103
+ * string: Excel on the web and on Windows, and Word on the web and on Windows only
4100
4104
  *
4101
4105
  * array of arrays: Excel and Word only
4102
4106
  *
@@ -4191,7 +4195,7 @@ declare namespace Office {
4191
4195
  * </tr>
4192
4196
  * <tr>
4193
4197
  * <td>A string</td>
4194
- * <td>The specified text is inserted as the value of the first bound cell. You can also specify a valid formula to add that formula to the bound cell. For example, setting data to <code>"=SUM(A1:A5)"</code> will total the values in the specified range. However, when you set a formula on the bound cell, after doing so, you can't read the added formula (or any pre-existing formula) from the bound cell. If you call the <code>Binding.getDataAsync</code> method on the bound cell to read its data, the method can return only the data displayed in the cell (the formula's result).</td>
4198
+ * <td>The specified text is inserted as the value of the first bound cell. You can also specify a valid formula to add that formula to the bound cell. For example, setting data to <code>"=SUM(A1:A5)"</code> will total the values in the specified range. However, when you set a formula on the bound cell, after doing so, you can't read the added formula (or any pre-existing formula) from the bound cell. If you call the <code>Binding.getDataAsync</code> method on the bound cell to read its data, the method can return only the data displayed in the cell (the formula's result).</td>
4195
4199
  * </tr>
4196
4200
  * <tr>
4197
4201
  * <td>An array of arrays ("matrix"), and the shape exactly matches the shape of the binding specified</td>
@@ -4723,7 +4727,7 @@ declare namespace Office {
4723
4727
  */
4724
4728
  license: object;
4725
4729
  /**
4726
- Provides access to the Microsoft Outlook add-in object model.
4730
+ * Provides access to the Microsoft Outlook add-in object model.
4727
4731
  *
4728
4732
  * @remarks
4729
4733
  *
@@ -5225,7 +5229,7 @@ declare namespace Office {
5225
5229
  getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;
5226
5230
  /**
5227
5231
  * Asynchronously gets any CustomXmlNodes in this custom XML part which match the specified XPath.
5228
- / *
5232
+ *
5229
5233
  * @remarks
5230
5234
  *
5231
5235
  * **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#customxmlparts | CustomXmlParts}
@@ -5930,7 +5934,7 @@ declare namespace Office {
5930
5934
  */
5931
5935
  getFilePropertiesAsync(callback?: (result: AsyncResult<Office.FileProperties>) => void): void;
5932
5936
  /**
5933
- * Reads the data contained in the current selection in the document.
5937
+ * Reads the data contained in the current selection in the document using the `Text` coercion type.
5934
5938
  *
5935
5939
  * @remarks
5936
5940
  *
@@ -5942,7 +5946,7 @@ declare namespace Office {
5942
5946
  *
5943
5947
  * **Supported applications**: Excel, PowerPoint, Project, Word
5944
5948
  *
5945
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
5949
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
5946
5950
  * the following information.
5947
5951
  *
5948
5952
  * <table>
@@ -5952,7 +5956,7 @@ declare namespace Office {
5952
5956
  * </tr>
5953
5957
  * <tr>
5954
5958
  * <td><code>AsyncResult.value</code></td>
5955
- * <td>Access the selected data as a string. If the selection does not contain text, returns an empty string.</td>
5959
+ * <td>Access the selected data as a string. If the selection doesn't contain text, returns an empty string.</td>
5956
5960
  * </tr>
5957
5961
  * <tr>
5958
5962
  * <td><code>AsyncResult.status</code></td>
@@ -5960,24 +5964,24 @@ declare namespace Office {
5960
5964
  * </tr>
5961
5965
  * <tr>
5962
5966
  * <td><code>AsyncResult.error</code></td>
5963
- * <td>Access an Error object that provides error information if the operation failed.</td>
5967
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
5964
5968
  * </tr>
5965
5969
  * <tr>
5966
5970
  * <td><code>AsyncResult.asyncContext</code></td>
5967
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
5971
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
5968
5972
  * </tr>
5969
5973
  * </table>
5970
5974
  *
5971
5975
  * @param coercionType Must be `Office.CoercionType.Text`.
5972
5976
  *
5973
- * @param options Provides options for customizing what data is returned and how it is formatted.
5977
+ * @param options Provides options for customizing what data is returned and how it's formatted.
5974
5978
  *
5975
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
5979
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
5976
5980
  * The `value` property of the result is a string containing the selected text.
5977
5981
  */
5978
5982
  getSelectedDataAsync(coercionType: Office.CoercionType.Text, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<string>) => void): void;
5979
5983
  /**
5980
- * Reads the data contained in the current selection in the document.
5984
+ * Reads the data contained in the current selection in the document using the `Table` coercion type.
5981
5985
  *
5982
5986
  * @remarks
5983
5987
  *
@@ -5989,7 +5993,7 @@ declare namespace Office {
5989
5993
  *
5990
5994
  * **Supported applications**: Excel, Word
5991
5995
  *
5992
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
5996
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
5993
5997
  * the following information.
5994
5998
  *
5995
5999
  * <table>
@@ -5999,7 +6003,7 @@ declare namespace Office {
5999
6003
  * </tr>
6000
6004
  * <tr>
6001
6005
  * <td><code>AsyncResult.value</code></td>
6002
- * <td>Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected.</td>
6006
+ * <td>Access the selected data as a {@link Office.TableData} object. Returns `null` if no table is selected.</td>
6003
6007
  * </tr>
6004
6008
  * <tr>
6005
6009
  * <td><code>AsyncResult.status</code></td>
@@ -6007,22 +6011,22 @@ declare namespace Office {
6007
6011
  * </tr>
6008
6012
  * <tr>
6009
6013
  * <td><code>AsyncResult.error</code></td>
6010
- * <td>Access an Error object that provides error information if the operation failed.</td>
6014
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6011
6015
  * </tr>
6012
6016
  * <tr>
6013
6017
  * <td><code>AsyncResult.asyncContext</code></td>
6014
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6018
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6015
6019
  * </tr>
6016
6020
  * </table>
6017
6021
  *
6018
6022
  * @param coercionType Must be `Office.CoercionType.Table`.
6019
- * @param options Provides options for customizing what data is returned and how it is formatted.
6020
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6023
+ * @param options Provides options for customizing what data is returned and how it's formatted.
6024
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6021
6025
  * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection.
6022
6026
  */
6023
6027
  getSelectedDataAsync(coercionType: Office.CoercionType.Table, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<TableData>) => void): void;
6024
6028
  /**
6025
- * Reads the data contained in the current selection in the document.
6029
+ * Reads the data contained in the current selection in the document using the `Matrix` coercion type.
6026
6030
  *
6027
6031
  * @remarks
6028
6032
  *
@@ -6034,7 +6038,7 @@ declare namespace Office {
6034
6038
  *
6035
6039
  * **Supported applications**: Excel, Word
6036
6040
  *
6037
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
6041
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
6038
6042
  * the following information.
6039
6043
  *
6040
6044
  * <table>
@@ -6052,22 +6056,22 @@ declare namespace Office {
6052
6056
  * </tr>
6053
6057
  * <tr>
6054
6058
  * <td><code>AsyncResult.error</code></td>
6055
- * <td>Access an Error object that provides error information if the operation failed.</td>
6059
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6056
6060
  * </tr>
6057
6061
  * <tr>
6058
6062
  * <td><code>AsyncResult.asyncContext</code></td>
6059
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6063
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6060
6064
  * </tr>
6061
6065
  * </table>
6062
6066
  *
6063
6067
  * @param coercionType Must be `Office.CoercionType.Matrix`.
6064
- * @param options Provides options for customizing what data is returned and how it is formatted.
6065
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6068
+ * @param options Provides options for customizing what data is returned and how it's formatted.
6069
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6066
6070
  * The `value` property of the result is an array of arrays containing the data in the current selection.
6067
6071
  */
6068
6072
  getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<any[][]>) => void): void;
6069
6073
  /**
6070
- * Reads the data contained in the current selection in the document.
6074
+ * Reads the data contained in the current selection in the document using the `SlideRange` coercion type.
6071
6075
  *
6072
6076
  * @remarks
6073
6077
  *
@@ -6075,7 +6079,7 @@ declare namespace Office {
6075
6079
  *
6076
6080
  * **Supported application**: PowerPoint
6077
6081
  *
6078
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
6082
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
6079
6083
  * the following information.
6080
6084
  *
6081
6085
  * <table>
@@ -6093,17 +6097,17 @@ declare namespace Office {
6093
6097
  * </tr>
6094
6098
  * <tr>
6095
6099
  * <td><code>AsyncResult.error</code></td>
6096
- * <td>Access an Error object that provides error information if the operation failed.</td>
6100
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6097
6101
  * </tr>
6098
6102
  * <tr>
6099
6103
  * <td><code>AsyncResult.asyncContext</code></td>
6100
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6104
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6101
6105
  * </tr>
6102
6106
  * </table>
6103
6107
  *
6104
6108
  * @param coercionType Must be `Office.CoercionType.SlideRange`.
6105
- * @param options Provides options for customizing what data is returned and how it is formatted.
6106
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6109
+ * @param options Provides options for customizing what data is returned and how it's formatted.
6110
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6107
6111
  * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides.
6108
6112
  */
6109
6113
  getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<SlideRange>) => void): void;
@@ -6163,7 +6167,7 @@ declare namespace Office {
6163
6167
  * </tr>
6164
6168
  * </table>
6165
6169
  *
6166
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
6170
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
6167
6171
  * the following information.
6168
6172
  *
6169
6173
  * <table>
@@ -6173,7 +6177,7 @@ declare namespace Office {
6173
6177
  * </tr>
6174
6178
  * <tr>
6175
6179
  * <td><code>AsyncResult.value</code></td>
6176
- * <td>Access the selected data. The type depends on the coercionType parameter specified in the call.</td>
6180
+ * <td>Access the selected data. The type depends on the <code>coercionType</code> parameter specified in the call.</td>
6177
6181
  * </tr>
6178
6182
  * <tr>
6179
6183
  * <td><code>AsyncResult.status</code></td>
@@ -6181,27 +6185,27 @@ declare namespace Office {
6181
6185
  * </tr>
6182
6186
  * <tr>
6183
6187
  * <td><code>AsyncResult.error</code></td>
6184
- * <td>Access an Error object that provides error information if the operation failed.</td>
6188
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6185
6189
  * </tr>
6186
6190
  * <tr>
6187
6191
  * <td><code>AsyncResult.asyncContext</code></td>
6188
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6192
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6189
6193
  * </tr>
6190
6194
  * </table>
6191
6195
  *
6192
- * For other coercion types or when the coercion type is not known at compile time, use the generic version of this method
6196
+ * For other coercion types or when the coercion type isn't known at compile time, use the generic version of this method
6193
6197
  * and specify the type parameter explicitly.
6194
6198
  *
6195
6199
  * @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types.
6196
- * @param options Provides options for customizing what data is returned and how it is formatted.
6197
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6200
+ * @param options Provides options for customizing what data is returned and how it's formatted.
6201
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6198
6202
  * The `value` property of the result is the data in the current selection.
6199
- * This is returned in the data structure or format you specified with the coercionType parameter.
6203
+ * This is returned in the data structure or format you specified with the `coercionType` parameter.
6200
6204
  * (See Remarks for more information about data coercion.)
6201
6205
  */
6202
6206
  getSelectedDataAsync<T>(coercionType: Office.CoercionType, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<T>) => void): void;
6203
6207
  /**
6204
- * Reads the data contained in the current selection in the document.
6208
+ * Reads the data contained in the current selection in the document using the `Text` coercion type.
6205
6209
  *
6206
6210
  * @remarks
6207
6211
  *
@@ -6213,7 +6217,7 @@ declare namespace Office {
6213
6217
  *
6214
6218
  * **Supported applications**: Excel, PowerPoint, Project, Word
6215
6219
  *
6216
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
6220
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
6217
6221
  * the following information.
6218
6222
  *
6219
6223
  * <table>
@@ -6231,21 +6235,21 @@ declare namespace Office {
6231
6235
  * </tr>
6232
6236
  * <tr>
6233
6237
  * <td><code>AsyncResult.error</code></td>
6234
- * <td>Access an Error object that provides error information if the operation failed.</td>
6238
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6235
6239
  * </tr>
6236
6240
  * <tr>
6237
6241
  * <td><code>AsyncResult.asyncContext</code></td>
6238
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6242
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6239
6243
  * </tr>
6240
6244
  * </table>
6241
6245
  *
6242
6246
  * @param coercionType Must be `Office.CoercionType.Text`.
6243
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6247
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6244
6248
  * The `value` property of the result is a string containing the selected text.
6245
6249
  */
6246
6250
  getSelectedDataAsync(coercionType: Office.CoercionType.Text, callback?: (result: AsyncResult<string>) => void): void;
6247
6251
  /**
6248
- * Reads the data contained in the current selection in the document.
6252
+ * Reads the data contained in the current selection in the document using the `Table` coercion type.
6249
6253
  *
6250
6254
  * @remarks
6251
6255
  *
@@ -6257,7 +6261,7 @@ declare namespace Office {
6257
6261
  *
6258
6262
  * **Supported applications**: Excel, Word
6259
6263
  *
6260
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
6264
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
6261
6265
  * the following information.
6262
6266
  *
6263
6267
  * <table>
@@ -6267,7 +6271,7 @@ declare namespace Office {
6267
6271
  * </tr>
6268
6272
  * <tr>
6269
6273
  * <td><code>AsyncResult.value</code></td>
6270
- * <td>Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected.</td>
6274
+ * <td>Access the selected data as a {@link Office.TableData} object. Returns `null` if no table is selected.</td>
6271
6275
  * </tr>
6272
6276
  * <tr>
6273
6277
  * <td><code>AsyncResult.status</code></td>
@@ -6275,21 +6279,21 @@ declare namespace Office {
6275
6279
  * </tr>
6276
6280
  * <tr>
6277
6281
  * <td><code>AsyncResult.error</code></td>
6278
- * <td>Access an Error object that provides error information if the operation failed.</td>
6282
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6279
6283
  * </tr>
6280
6284
  * <tr>
6281
6285
  * <td><code>AsyncResult.asyncContext</code></td>
6282
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6286
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6283
6287
  * </tr>
6284
6288
  * </table>
6285
6289
  *
6286
6290
  * @param coercionType Must be `Office.CoercionType.Table`.
6287
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6291
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6288
6292
  * The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection.
6289
6293
  */
6290
6294
  getSelectedDataAsync(coercionType: Office.CoercionType.Table, callback?: (result: AsyncResult<TableData>) => void): void;
6291
6295
  /**
6292
- * Reads the data contained in the current selection in the document.
6296
+ * Reads the data contained in the current selection in the document using the `Matrix` coercion type.
6293
6297
  *
6294
6298
  * @remarks
6295
6299
  *
@@ -6301,7 +6305,7 @@ declare namespace Office {
6301
6305
  *
6302
6306
  * **Supported applications**: Excel, Word
6303
6307
  *
6304
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
6308
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
6305
6309
  * the following information.
6306
6310
  *
6307
6311
  * <table>
@@ -6319,21 +6323,21 @@ declare namespace Office {
6319
6323
  * </tr>
6320
6324
  * <tr>
6321
6325
  * <td><code>AsyncResult.error</code></td>
6322
- * <td>Access an Error object that provides error information if the operation failed.</td>
6326
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6323
6327
  * </tr>
6324
6328
  * <tr>
6325
6329
  * <td><code>AsyncResult.asyncContext</code></td>
6326
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6330
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6327
6331
  * </tr>
6328
6332
  * </table>
6329
6333
  *
6330
6334
  * @param coercionType Must be `Office.CoercionType.Matrix`.
6331
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6335
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6332
6336
  * The `value` property of the result is an array of arrays containing the data in the current selection.
6333
6337
  */
6334
6338
  getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, callback?: (result: AsyncResult<any[][]>) => void): void;
6335
6339
  /**
6336
- * Reads the data contained in the current selection in the document.
6340
+ * Reads the data contained in the current selection in the document using the `SlideRange` coercion type.
6337
6341
  *
6338
6342
  * @remarks
6339
6343
  *
@@ -6341,7 +6345,7 @@ declare namespace Office {
6341
6345
  *
6342
6346
  * **Supported application**: PowerPoint
6343
6347
  *
6344
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
6348
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
6345
6349
  * the following information.
6346
6350
  *
6347
6351
  * <table>
@@ -6359,16 +6363,16 @@ declare namespace Office {
6359
6363
  * </tr>
6360
6364
  * <tr>
6361
6365
  * <td><code>AsyncResult.error</code></td>
6362
- * <td>Access an Error object that provides error information if the operation failed.</td>
6366
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6363
6367
  * </tr>
6364
6368
  * <tr>
6365
6369
  * <td><code>AsyncResult.asyncContext</code></td>
6366
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6370
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6367
6371
  * </tr>
6368
6372
  * </table>
6369
6373
  *
6370
6374
  * @param coercionType Must be `Office.CoercionType.SlideRange`.
6371
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6375
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6372
6376
  * The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides.
6373
6377
  */
6374
6378
  getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, callback?: (result: AsyncResult<SlideRange>) => void): void;
@@ -6428,7 +6432,7 @@ declare namespace Office {
6428
6432
  * </tr>
6429
6433
  * </table>
6430
6434
  *
6431
- * In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
6435
+ * In the `callback` function that's passed to the `getSelectedDataAsync` method, you can use the properties of the `AsyncResult` object to return
6432
6436
  * the following information.
6433
6437
  *
6434
6438
  * <table>
@@ -6438,7 +6442,7 @@ declare namespace Office {
6438
6442
  * </tr>
6439
6443
  * <tr>
6440
6444
  * <td><code>AsyncResult.value</code></td>
6441
- * <td>Access the selected data. The type depends on the coercionType parameter specified in the call.</td>
6445
+ * <td>Access the selected data. The type depends on the `coercionType` parameter specified in the call.</td>
6442
6446
  * </tr>
6443
6447
  * <tr>
6444
6448
  * <td><code>AsyncResult.status</code></td>
@@ -6446,11 +6450,11 @@ declare namespace Office {
6446
6450
  * </tr>
6447
6451
  * <tr>
6448
6452
  * <td><code>AsyncResult.error</code></td>
6449
- * <td>Access an Error object that provides error information if the operation failed.</td>
6453
+ * <td>Access an <code>Error</code> object that provides error information if the operation failed.</td>
6450
6454
  * </tr>
6451
6455
  * <tr>
6452
6456
  * <td><code>AsyncResult.asyncContext</code></td>
6453
- * <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
6457
+ * <td>Define an item of any type that's returned in the <code>AsyncResult</code> object without being altered.</td>
6454
6458
  * </tr>
6455
6459
  * </table>
6456
6460
  *
@@ -6458,9 +6462,9 @@ declare namespace Office {
6458
6462
  * and specify the type parameter explicitly.
6459
6463
  *
6460
6464
  * @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types.
6461
- * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6465
+ * @param callback Optional. A function that's invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
6462
6466
  * The `value` property of the result is the data in the current selection.
6463
- * This is returned in the data structure or format you specified with the coercionType parameter.
6467
+ * This is returned in the data structure or format you specified with the `coercionType` parameter.
6464
6468
  * (See Remarks for more information about data coercion.)
6465
6469
  */
6466
6470
  getSelectedDataAsync<T>(coercionType: Office.CoercionType, callback?: (result: AsyncResult<T>) => void): void;
@@ -7064,7 +7068,7 @@ declare namespace Office {
7064
7068
  */
7065
7069
  getWSSUrlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;
7066
7070
  /**
7067
- * Project documents only. Get the WSS Url and list name for the Tasks List, the MPP is synced too.
7071
+ * Project documents only. Get the WSS URL and list name for the Tasks List, the MPP is synced too.
7068
7072
  * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
7069
7073
  * The `value` property of the result contains the following properties:
7070
7074
  * `listName` - the name of the synchronized SharePoint task list.
@@ -7178,7 +7182,7 @@ declare namespace Office {
7178
7182
  *
7179
7183
  * **Important**: This API works only in Project on Windows desktop.
7180
7184
  *
7181
- * @param resourceId Either a string or value of the Resource Id.
7185
+ * @param resourceId Either a string or value of the resource ID.
7182
7186
  * @param fieldId Resource Fields.
7183
7187
  * @param fieldValue Value of the target field.
7184
7188
  * @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
@@ -7190,7 +7194,7 @@ declare namespace Office {
7190
7194
  *
7191
7195
  * **Important**: This API works only in Project on Windows desktop.
7192
7196
  *
7193
- * @param taskId Either a string or value of the Task ID.
7197
+ * @param taskId Either a string or value of the task ID.
7194
7198
  * @param fieldId Task Fields.
7195
7199
  * @param fieldValue Value of the target field.
7196
7200
  * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
@@ -7911,7 +7915,7 @@ declare namespace Office {
7911
7915
  *
7912
7916
  * The name of a setting is a string, while the value can be a string, number, boolean, null, object, or array.
7913
7917
  *
7914
- * The Settings object is automatically loaded as part of the `Document` object, and is available by calling the settings property of that object
7918
+ * The `Settings` object is automatically loaded as part of the `Document` object, and is available by calling the settings property of that object
7915
7919
  * when the add-in is activated.
7916
7920
  *
7917
7921
  * The developer is responsible for calling the `saveAsync` method after adding or deleting settings to save the settings in the document.
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.577",
3
+ "version": "1.0.578",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "9f7fb30564ef148081316fd9c06db737ee9c3f874e37aae427183fcc74e800c9",
49
+ "typesPublisherContentHash": "d775a08a3513912fd603eafd33c30e8eb78985331ba88fcb14a64688ca9744ec",
50
50
  "typeScriptVersion": "5.2"
51
51
  }