@types/office-js-preview 1.0.674 → 1.0.676
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 +424 -26
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Tue, 06 Jan 2026 21:35:44 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -5931,17 +5931,58 @@ declare namespace Office {
|
|
|
5931
5931
|
*
|
|
5932
5932
|
* **Requirement sets**:
|
|
5933
5933
|
*
|
|
5934
|
-
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#
|
|
5934
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
5935
5935
|
*
|
|
5936
|
-
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#
|
|
5936
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion}
|
|
5937
5937
|
*
|
|
5938
|
-
*
|
|
5938
|
+
* **Supported applications**: Excel, PowerPoint, Project, Word
|
|
5939
|
+
*
|
|
5940
|
+
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
5941
|
+
* the following information.
|
|
5942
|
+
*
|
|
5943
|
+
* <table>
|
|
5944
|
+
* <tr>
|
|
5945
|
+
* <th>Property</th>
|
|
5946
|
+
* <th>Use</th>
|
|
5947
|
+
* </tr>
|
|
5948
|
+
* <tr>
|
|
5949
|
+
* <td><code>AsyncResult.value</code></td>
|
|
5950
|
+
* <td>Access the selected data as a string. If the selection does not contain text, returns an empty string.</td>
|
|
5951
|
+
* </tr>
|
|
5952
|
+
* <tr>
|
|
5953
|
+
* <td><code>AsyncResult.status</code></td>
|
|
5954
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
5955
|
+
* </tr>
|
|
5956
|
+
* <tr>
|
|
5957
|
+
* <td><code>AsyncResult.error</code></td>
|
|
5958
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
5959
|
+
* </tr>
|
|
5960
|
+
* <tr>
|
|
5961
|
+
* <td><code>AsyncResult.asyncContext</code></td>
|
|
5962
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
5963
|
+
* </tr>
|
|
5964
|
+
* </table>
|
|
5965
|
+
*
|
|
5966
|
+
* @param coercionType Must be `Office.CoercionType.Text`.
|
|
5967
|
+
*
|
|
5968
|
+
* @param options Provides options for customizing what data is returned and how it is formatted.
|
|
5969
|
+
*
|
|
5970
|
+
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
5971
|
+
* The `value` property of the result is a string containing the selected text.
|
|
5972
|
+
*/
|
|
5973
|
+
getSelectedDataAsync(coercionType: Office.CoercionType.Text, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<string>) => void): void;
|
|
5974
|
+
/**
|
|
5975
|
+
* Reads the data contained in the current selection in the document.
|
|
5976
|
+
*
|
|
5977
|
+
* @remarks
|
|
5978
|
+
*
|
|
5979
|
+
* **Requirement sets**:
|
|
5939
5980
|
*
|
|
5940
5981
|
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
5941
5982
|
*
|
|
5942
|
-
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion}
|
|
5983
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion}
|
|
5943
5984
|
*
|
|
5944
|
-
*
|
|
5985
|
+
* **Supported applications**: Excel, Word
|
|
5945
5986
|
*
|
|
5946
5987
|
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
5947
5988
|
* the following information.
|
|
@@ -5953,7 +5994,93 @@ declare namespace Office {
|
|
|
5953
5994
|
* </tr>
|
|
5954
5995
|
* <tr>
|
|
5955
5996
|
* <td><code>AsyncResult.value</code></td>
|
|
5956
|
-
* <td>
|
|
5997
|
+
* <td>Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected.</td>
|
|
5998
|
+
* </tr>
|
|
5999
|
+
* <tr>
|
|
6000
|
+
* <td><code>AsyncResult.status</code></td>
|
|
6001
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6002
|
+
* </tr>
|
|
6003
|
+
* <tr>
|
|
6004
|
+
* <td><code>AsyncResult.error</code></td>
|
|
6005
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6006
|
+
* </tr>
|
|
6007
|
+
* <tr>
|
|
6008
|
+
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6009
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6010
|
+
* </tr>
|
|
6011
|
+
* </table>
|
|
6012
|
+
*
|
|
6013
|
+
* @param coercionType Must be `Office.CoercionType.Table`.
|
|
6014
|
+
* @param options Provides options for customizing what data is returned and how it is formatted.
|
|
6015
|
+
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6016
|
+
* The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection.
|
|
6017
|
+
*/
|
|
6018
|
+
getSelectedDataAsync(coercionType: Office.CoercionType.Table, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<TableData>) => void): void;
|
|
6019
|
+
/**
|
|
6020
|
+
* Reads the data contained in the current selection in the document.
|
|
6021
|
+
*
|
|
6022
|
+
* @remarks
|
|
6023
|
+
*
|
|
6024
|
+
* **Requirement sets**:
|
|
6025
|
+
*
|
|
6026
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
6027
|
+
*
|
|
6028
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion}
|
|
6029
|
+
*
|
|
6030
|
+
* **Supported applications**: Excel, Word
|
|
6031
|
+
*
|
|
6032
|
+
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
6033
|
+
* the following information.
|
|
6034
|
+
*
|
|
6035
|
+
* <table>
|
|
6036
|
+
* <tr>
|
|
6037
|
+
* <th>Property</th>
|
|
6038
|
+
* <th>Use</th>
|
|
6039
|
+
* </tr>
|
|
6040
|
+
* <tr>
|
|
6041
|
+
* <td><code>AsyncResult.value</code></td>
|
|
6042
|
+
* <td>Access the selected data as an array of arrays. Returns an empty array if no data is selected.</td>
|
|
6043
|
+
* </tr>
|
|
6044
|
+
* <tr>
|
|
6045
|
+
* <td><code>AsyncResult.status</code></td>
|
|
6046
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6047
|
+
* </tr>
|
|
6048
|
+
* <tr>
|
|
6049
|
+
* <td><code>AsyncResult.error</code></td>
|
|
6050
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6051
|
+
* </tr>
|
|
6052
|
+
* <tr>
|
|
6053
|
+
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6054
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6055
|
+
* </tr>
|
|
6056
|
+
* </table>
|
|
6057
|
+
*
|
|
6058
|
+
* @param coercionType Must be `Office.CoercionType.Matrix`.
|
|
6059
|
+
* @param options Provides options for customizing what data is returned and how it is formatted.
|
|
6060
|
+
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6061
|
+
* The `value` property of the result is an array of arrays containing the data in the current selection.
|
|
6062
|
+
*/
|
|
6063
|
+
getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<any[][]>) => void): void;
|
|
6064
|
+
/**
|
|
6065
|
+
* Reads the data contained in the current selection in the document.
|
|
6066
|
+
*
|
|
6067
|
+
* @remarks
|
|
6068
|
+
*
|
|
6069
|
+
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
6070
|
+
*
|
|
6071
|
+
* **Supported application**: PowerPoint
|
|
6072
|
+
*
|
|
6073
|
+
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
6074
|
+
* the following information.
|
|
6075
|
+
*
|
|
6076
|
+
* <table>
|
|
6077
|
+
* <tr>
|
|
6078
|
+
* <th>Property</th>
|
|
6079
|
+
* <th>Use</th>
|
|
6080
|
+
* </tr>
|
|
6081
|
+
* <tr>
|
|
6082
|
+
* <td><code>AsyncResult.value</code></td>
|
|
6083
|
+
* <td>Access the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.</td>
|
|
5957
6084
|
* </tr>
|
|
5958
6085
|
* <tr>
|
|
5959
6086
|
* <td><code>AsyncResult.status</code></td>
|
|
@@ -5969,6 +6096,31 @@ declare namespace Office {
|
|
|
5969
6096
|
* </tr>
|
|
5970
6097
|
* </table>
|
|
5971
6098
|
*
|
|
6099
|
+
* @param coercionType Must be `Office.CoercionType.SlideRange`.
|
|
6100
|
+
* @param options Provides options for customizing what data is returned and how it is formatted.
|
|
6101
|
+
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6102
|
+
* The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides.
|
|
6103
|
+
*/
|
|
6104
|
+
getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<SlideRange>) => void): void;
|
|
6105
|
+
/**
|
|
6106
|
+
* Reads the data contained in the current selection in the document.
|
|
6107
|
+
*
|
|
6108
|
+
* @remarks
|
|
6109
|
+
*
|
|
6110
|
+
* **Requirement sets**:
|
|
6111
|
+
*
|
|
6112
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
6113
|
+
*
|
|
6114
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
6115
|
+
*
|
|
6116
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
6117
|
+
*
|
|
6118
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
6119
|
+
*
|
|
6120
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
6121
|
+
*
|
|
6122
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
6123
|
+
*
|
|
5972
6124
|
* The possible values for the {@link Office.CoercionType} parameter vary by the Office application.
|
|
5973
6125
|
*
|
|
5974
6126
|
* <table>
|
|
@@ -6006,10 +6158,37 @@ declare namespace Office {
|
|
|
6006
6158
|
* </tr>
|
|
6007
6159
|
* </table>
|
|
6008
6160
|
*
|
|
6009
|
-
*
|
|
6161
|
+
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
6162
|
+
* the following information.
|
|
6010
6163
|
*
|
|
6011
|
-
*
|
|
6164
|
+
* <table>
|
|
6165
|
+
* <tr>
|
|
6166
|
+
* <th>Property</th>
|
|
6167
|
+
* <th>Use</th>
|
|
6168
|
+
* </tr>
|
|
6169
|
+
* <tr>
|
|
6170
|
+
* <td><code>AsyncResult.value</code></td>
|
|
6171
|
+
* <td>Access the selected data. The type depends on the coercionType parameter specified in the call.</td>
|
|
6172
|
+
* </tr>
|
|
6173
|
+
* <tr>
|
|
6174
|
+
* <td><code>AsyncResult.status</code></td>
|
|
6175
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6176
|
+
* </tr>
|
|
6177
|
+
* <tr>
|
|
6178
|
+
* <td><code>AsyncResult.error</code></td>
|
|
6179
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6180
|
+
* </tr>
|
|
6181
|
+
* <tr>
|
|
6182
|
+
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6183
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6184
|
+
* </tr>
|
|
6185
|
+
* </table>
|
|
6186
|
+
*
|
|
6187
|
+
* For other coercion types or when the coercion type is not known at compile time, use the generic version of this method
|
|
6188
|
+
* and specify the type parameter explicitly.
|
|
6012
6189
|
*
|
|
6190
|
+
* @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types.
|
|
6191
|
+
* @param options Provides options for customizing what data is returned and how it is formatted.
|
|
6013
6192
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6014
6193
|
* The `value` property of the result is the data in the current selection.
|
|
6015
6194
|
* This is returned in the data structure or format you specified with the coercionType parameter.
|
|
@@ -6023,17 +6202,55 @@ declare namespace Office {
|
|
|
6023
6202
|
*
|
|
6024
6203
|
* **Requirement sets**:
|
|
6025
6204
|
*
|
|
6026
|
-
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#
|
|
6205
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
6027
6206
|
*
|
|
6028
|
-
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#
|
|
6207
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion}
|
|
6029
6208
|
*
|
|
6030
|
-
*
|
|
6209
|
+
* **Supported applications**: Excel, PowerPoint, Project, Word
|
|
6210
|
+
*
|
|
6211
|
+
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
6212
|
+
* the following information.
|
|
6213
|
+
*
|
|
6214
|
+
* <table>
|
|
6215
|
+
* <tr>
|
|
6216
|
+
* <th>Property</th>
|
|
6217
|
+
* <th>Use</th>
|
|
6218
|
+
* </tr>
|
|
6219
|
+
* <tr>
|
|
6220
|
+
* <td><code>AsyncResult.value</code></td>
|
|
6221
|
+
* <td>Access the selected data as a string. If the selection does not contain text, returns an empty string.</td>
|
|
6222
|
+
* </tr>
|
|
6223
|
+
* <tr>
|
|
6224
|
+
* <td><code>AsyncResult.status</code></td>
|
|
6225
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6226
|
+
* </tr>
|
|
6227
|
+
* <tr>
|
|
6228
|
+
* <td><code>AsyncResult.error</code></td>
|
|
6229
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6230
|
+
* </tr>
|
|
6231
|
+
* <tr>
|
|
6232
|
+
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6233
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6234
|
+
* </tr>
|
|
6235
|
+
* </table>
|
|
6236
|
+
*
|
|
6237
|
+
* @param coercionType Must be `Office.CoercionType.Text`.
|
|
6238
|
+
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6239
|
+
* The `value` property of the result is a string containing the selected text.
|
|
6240
|
+
*/
|
|
6241
|
+
getSelectedDataAsync(coercionType: Office.CoercionType.Text, callback?: (result: AsyncResult<string>) => void): void;
|
|
6242
|
+
/**
|
|
6243
|
+
* Reads the data contained in the current selection in the document.
|
|
6244
|
+
*
|
|
6245
|
+
* @remarks
|
|
6246
|
+
*
|
|
6247
|
+
* **Requirement sets**:
|
|
6031
6248
|
*
|
|
6032
6249
|
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
6033
6250
|
*
|
|
6034
|
-
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion}
|
|
6251
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion}
|
|
6035
6252
|
*
|
|
6036
|
-
*
|
|
6253
|
+
* **Supported applications**: Excel, Word
|
|
6037
6254
|
*
|
|
6038
6255
|
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
6039
6256
|
* the following information.
|
|
@@ -6045,7 +6262,51 @@ declare namespace Office {
|
|
|
6045
6262
|
* </tr>
|
|
6046
6263
|
* <tr>
|
|
6047
6264
|
* <td><code>AsyncResult.value</code></td>
|
|
6048
|
-
* <td>
|
|
6265
|
+
* <td>Access the selected data as a {@link Office.TableData} object. Returns null if no table is selected.</td>
|
|
6266
|
+
* </tr>
|
|
6267
|
+
* <tr>
|
|
6268
|
+
* <td><code>AsyncResult.status</code></td>
|
|
6269
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6270
|
+
* </tr>
|
|
6271
|
+
* <tr>
|
|
6272
|
+
* <td><code>AsyncResult.error</code></td>
|
|
6273
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6274
|
+
* </tr>
|
|
6275
|
+
* <tr>
|
|
6276
|
+
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6277
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6278
|
+
* </tr>
|
|
6279
|
+
* </table>
|
|
6280
|
+
*
|
|
6281
|
+
* @param coercionType Must be `Office.CoercionType.Table`.
|
|
6282
|
+
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6283
|
+
* The `value` property of the result is a {@link Office.TableData} object containing the data in the current selection.
|
|
6284
|
+
*/
|
|
6285
|
+
getSelectedDataAsync(coercionType: Office.CoercionType.Table, callback?: (result: AsyncResult<TableData>) => void): void;
|
|
6286
|
+
/**
|
|
6287
|
+
* Reads the data contained in the current selection in the document.
|
|
6288
|
+
*
|
|
6289
|
+
* @remarks
|
|
6290
|
+
*
|
|
6291
|
+
* **Requirement sets**:
|
|
6292
|
+
*
|
|
6293
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
6294
|
+
*
|
|
6295
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion}
|
|
6296
|
+
*
|
|
6297
|
+
* **Supported applications**: Excel, Word
|
|
6298
|
+
*
|
|
6299
|
+
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
6300
|
+
* the following information.
|
|
6301
|
+
*
|
|
6302
|
+
* <table>
|
|
6303
|
+
* <tr>
|
|
6304
|
+
* <th>Property</th>
|
|
6305
|
+
* <th>Use</th>
|
|
6306
|
+
* </tr>
|
|
6307
|
+
* <tr>
|
|
6308
|
+
* <td><code>AsyncResult.value</code></td>
|
|
6309
|
+
* <td>Access the selected data as an array of arrays. Returns an empty array if no data is selected.</td>
|
|
6049
6310
|
* </tr>
|
|
6050
6311
|
* <tr>
|
|
6051
6312
|
* <td><code>AsyncResult.status</code></td>
|
|
@@ -6061,6 +6322,70 @@ declare namespace Office {
|
|
|
6061
6322
|
* </tr>
|
|
6062
6323
|
* </table>
|
|
6063
6324
|
*
|
|
6325
|
+
* @param coercionType Must be `Office.CoercionType.Matrix`.
|
|
6326
|
+
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6327
|
+
* The `value` property of the result is an array of arrays containing the data in the current selection.
|
|
6328
|
+
*/
|
|
6329
|
+
getSelectedDataAsync(coercionType: Office.CoercionType.Matrix, callback?: (result: AsyncResult<any[][]>) => void): void;
|
|
6330
|
+
/**
|
|
6331
|
+
* Reads the data contained in the current selection in the document.
|
|
6332
|
+
*
|
|
6333
|
+
* @remarks
|
|
6334
|
+
*
|
|
6335
|
+
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
6336
|
+
*
|
|
6337
|
+
* **Supported application**: PowerPoint
|
|
6338
|
+
*
|
|
6339
|
+
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
6340
|
+
* the following information.
|
|
6341
|
+
*
|
|
6342
|
+
* <table>
|
|
6343
|
+
* <tr>
|
|
6344
|
+
* <th>Property</th>
|
|
6345
|
+
* <th>Use</th>
|
|
6346
|
+
* </tr>
|
|
6347
|
+
* <tr>
|
|
6348
|
+
* <td><code>AsyncResult.value</code></td>
|
|
6349
|
+
* <td>Access the selected slides as a {@link Office.SlideRange} object containing the IDs, titles, and indexes of the selected slides.</td>
|
|
6350
|
+
* </tr>
|
|
6351
|
+
* <tr>
|
|
6352
|
+
* <td><code>AsyncResult.status</code></td>
|
|
6353
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6354
|
+
* </tr>
|
|
6355
|
+
* <tr>
|
|
6356
|
+
* <td><code>AsyncResult.error</code></td>
|
|
6357
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6358
|
+
* </tr>
|
|
6359
|
+
* <tr>
|
|
6360
|
+
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6361
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6362
|
+
* </tr>
|
|
6363
|
+
* </table>
|
|
6364
|
+
*
|
|
6365
|
+
* @param coercionType Must be `Office.CoercionType.SlideRange`.
|
|
6366
|
+
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6367
|
+
* The `value` property of the result is a {@link Office.SlideRange} object containing the selected slides.
|
|
6368
|
+
*/
|
|
6369
|
+
getSelectedDataAsync(coercionType: Office.CoercionType.SlideRange, callback?: (result: AsyncResult<SlideRange>) => void): void;
|
|
6370
|
+
/**
|
|
6371
|
+
* Reads the data contained in the current selection in the document.
|
|
6372
|
+
*
|
|
6373
|
+
* @remarks
|
|
6374
|
+
*
|
|
6375
|
+
* **Requirement sets**:
|
|
6376
|
+
*
|
|
6377
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#htmlcoercion | HtmlCoercion} (when using `Office.CoercionType.Html`)
|
|
6378
|
+
*
|
|
6379
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#matrixcoercion | MatrixCoercion} (when using `Office.CoercionType.Matrix`)
|
|
6380
|
+
*
|
|
6381
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#ooxmlcoercion | OoxmlCoercion} (when using `Office.CoercionType.Ooxml`)
|
|
6382
|
+
*
|
|
6383
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#selection | Selection}
|
|
6384
|
+
*
|
|
6385
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#tablecoercion | TableCoercion} (when using `Office.CoercionType.Table`)
|
|
6386
|
+
*
|
|
6387
|
+
* - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/office-add-in-requirement-sets#textcoercion | TextCoercion} (when using `Office.CoercionType.Text`)
|
|
6388
|
+
*
|
|
6064
6389
|
* The possible values for the {@link Office.CoercionType} parameter vary by the Office application.
|
|
6065
6390
|
*
|
|
6066
6391
|
* <table>
|
|
@@ -6098,6 +6423,35 @@ declare namespace Office {
|
|
|
6098
6423
|
* </tr>
|
|
6099
6424
|
* </table>
|
|
6100
6425
|
*
|
|
6426
|
+
* In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return
|
|
6427
|
+
* the following information.
|
|
6428
|
+
*
|
|
6429
|
+
* <table>
|
|
6430
|
+
* <tr>
|
|
6431
|
+
* <th>Property</th>
|
|
6432
|
+
* <th>Use</th>
|
|
6433
|
+
* </tr>
|
|
6434
|
+
* <tr>
|
|
6435
|
+
* <td><code>AsyncResult.value</code></td>
|
|
6436
|
+
* <td>Access the selected data. The type depends on the coercionType parameter specified in the call.</td>
|
|
6437
|
+
* </tr>
|
|
6438
|
+
* <tr>
|
|
6439
|
+
* <td><code>AsyncResult.status</code></td>
|
|
6440
|
+
* <td>Determine the success or failure of the operation.</td>
|
|
6441
|
+
* </tr>
|
|
6442
|
+
* <tr>
|
|
6443
|
+
* <td><code>AsyncResult.error</code></td>
|
|
6444
|
+
* <td>Access an Error object that provides error information if the operation failed.</td>
|
|
6445
|
+
* </tr>
|
|
6446
|
+
* <tr>
|
|
6447
|
+
* <td><code>AsyncResult.asyncContext</code></td>
|
|
6448
|
+
* <td>Define an item of any type that's returned in the AsyncResult object without being altered.</td>
|
|
6449
|
+
* </tr>
|
|
6450
|
+
* </table>
|
|
6451
|
+
*
|
|
6452
|
+
* For other coercion types or when the coercion type is not known at compile time, use the generic version of this method
|
|
6453
|
+
* and specify the type parameter explicitly.
|
|
6454
|
+
*
|
|
6101
6455
|
* @param coercionType The type of data structure to return. See the Remarks section for each application's supported coercion types.
|
|
6102
6456
|
* @param callback Optional. A function that is invoked when the callback returns, whose only parameter is of type {@link Office.AsyncResult}.
|
|
6103
6457
|
* The `value` property of the result is the data in the current selection.
|
|
@@ -8593,6 +8947,36 @@ declare namespace Office {
|
|
|
8593
8947
|
*/
|
|
8594
8948
|
rows: any[][];
|
|
8595
8949
|
}
|
|
8950
|
+
/**
|
|
8951
|
+
* Represents a single slide in a PowerPoint presentation.
|
|
8952
|
+
* This interface is used as part of the {@link Office.SlideRange} object returned by
|
|
8953
|
+
* {@link Office.Document.getSelectedDataAsync} when called with {@link Office.CoercionType.SlideRange}.
|
|
8954
|
+
*/
|
|
8955
|
+
interface Slide {
|
|
8956
|
+
/**
|
|
8957
|
+
* Gets the unique ID of the slide.
|
|
8958
|
+
*/
|
|
8959
|
+
id: number;
|
|
8960
|
+
/**
|
|
8961
|
+
* Gets the title of the slide.
|
|
8962
|
+
*/
|
|
8963
|
+
title: string;
|
|
8964
|
+
/**
|
|
8965
|
+
* Gets the 1-based index of the slide within the presentation.
|
|
8966
|
+
*/
|
|
8967
|
+
index: number;
|
|
8968
|
+
}
|
|
8969
|
+
/**
|
|
8970
|
+
* Represents the selected slides in a PowerPoint presentation.
|
|
8971
|
+
* This object is returned when calling {@link Office.Document.getSelectedDataAsync} with {@link Office.CoercionType.SlideRange} in PowerPoint.
|
|
8972
|
+
*
|
|
8973
|
+
*/
|
|
8974
|
+
interface SlideRange {
|
|
8975
|
+
/**
|
|
8976
|
+
* Gets an array of the selected slides.
|
|
8977
|
+
*/
|
|
8978
|
+
slides: Slide[];
|
|
8979
|
+
}
|
|
8596
8980
|
/**
|
|
8597
8981
|
* Provides methods to manage the task pane of an add-in.
|
|
8598
8982
|
*
|
|
@@ -17046,7 +17430,8 @@ declare namespace Office {
|
|
|
17046
17430
|
* **Important**:
|
|
17047
17431
|
*
|
|
17048
17432
|
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
17049
|
-
* In this case, the `from` property returns the
|
|
17433
|
+
* In this case, the `from` property returns the email address of the mailbox owner or shared mailbox, and the `sender` property returns the address of the delegate.
|
|
17434
|
+
* If the delegate has both **Send on behalf** and **Send as** permissions, the **Send as** permission applies. For information about mailbox delegation, see
|
|
17050
17435
|
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
17051
17436
|
*
|
|
17052
17437
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined.
|
|
@@ -17062,8 +17447,13 @@ declare namespace Office {
|
|
|
17062
17447
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
17063
17448
|
*
|
|
17064
17449
|
* **Important**: In the **Sent Items** folder, the `internetMessageId` may not be available yet on recently sent items. In that case,
|
|
17065
|
-
* consider using
|
|
17066
|
-
*
|
|
17450
|
+
* consider using one of the following options depending on your Exchange environment.
|
|
17451
|
+
*
|
|
17452
|
+
* - For Exchange Online, use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/microsoft-graph | Microsoft Graph} to get the
|
|
17453
|
+
* {@link https://learn.microsoft.com/graph/api/resources/message | internetMessageId} property.
|
|
17454
|
+
*
|
|
17455
|
+
* - For Exchange Server (on-premises), use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/web-services | Exchange Web Services} to get the
|
|
17456
|
+
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/internetmessageid | InternetMessageId} property from the server.
|
|
17067
17457
|
*/
|
|
17068
17458
|
internetMessageId: string;
|
|
17069
17459
|
/**
|
|
@@ -17252,7 +17642,8 @@ declare namespace Office {
|
|
|
17252
17642
|
* **Important**:
|
|
17253
17643
|
*
|
|
17254
17644
|
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
17255
|
-
* In this case, the `from` property returns the
|
|
17645
|
+
* In this case, the `from` property returns the email address of the mailbox owner or shared mailbox, and the `sender` property returns the address of the delegate.
|
|
17646
|
+
* If the delegate has both **Send on behalf** and **Send as** permissions, the **Send as** permission applies. For information about mailbox delegation, see
|
|
17256
17647
|
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
17257
17648
|
*
|
|
17258
17649
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined.
|
|
@@ -21355,7 +21746,8 @@ declare namespace Office {
|
|
|
21355
21746
|
* **Important**:
|
|
21356
21747
|
*
|
|
21357
21748
|
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
21358
|
-
* In this case, the `from` property returns the
|
|
21749
|
+
* In this case, the `from` property returns the email address of the mailbox owner or shared mailbox, and the `sender` property returns the address of the delegate.
|
|
21750
|
+
* If the delegate has both **Send on behalf** and **Send as** permissions, the **Send as** permission applies. For information about mailbox delegation, see
|
|
21359
21751
|
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
21360
21752
|
*
|
|
21361
21753
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `from` property is undefined.
|
|
@@ -21364,15 +21756,20 @@ declare namespace Office {
|
|
|
21364
21756
|
/**
|
|
21365
21757
|
* Gets the internet message identifier for an email message.
|
|
21366
21758
|
*
|
|
21367
|
-
* **Important**: In the **Sent Items** folder, the `internetMessageId` may not be available yet on recently sent items. In that case,
|
|
21368
|
-
* consider using {@link https://learn.microsoft.com/office/dev/add-ins/outlook/web-services | Exchange Web Services} to get this
|
|
21369
|
-
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/internetmessageid | property from the server}.
|
|
21370
|
-
*
|
|
21371
21759
|
* @remarks
|
|
21372
21760
|
*
|
|
21373
21761
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
21374
21762
|
*
|
|
21375
21763
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
21764
|
+
*
|
|
21765
|
+
* **Important**: In the **Sent Items** folder, the `internetMessageId` may not be available yet on recently sent items. In that case,
|
|
21766
|
+
* consider using one of the following options depending on your Exchange environment.
|
|
21767
|
+
*
|
|
21768
|
+
* - For Exchange Online, use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/microsoft-graph | Microsoft Graph} to get the
|
|
21769
|
+
* {@link https://learn.microsoft.com/graph/api/resources/message | internetMessageId} property.
|
|
21770
|
+
*
|
|
21771
|
+
* - For Exchange Server (on-premises), use {@link https://learn.microsoft.com/office/dev/add-ins/outlook/web-services | Exchange Web Services} to get the
|
|
21772
|
+
* {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/internetmessageid | InternetMessageId} property from the server.
|
|
21376
21773
|
*/
|
|
21377
21774
|
internetMessageId: string;
|
|
21378
21775
|
/**
|
|
@@ -21550,7 +21947,8 @@ declare namespace Office {
|
|
|
21550
21947
|
* **Important**:
|
|
21551
21948
|
*
|
|
21552
21949
|
* - The `from` and `sender` properties represent the same person unless the message is sent by a delegate with **Send on behalf** permissions.
|
|
21553
|
-
* In this case, the `from` property returns the
|
|
21950
|
+
* In this case, the `from` property returns the email address of the mailbox owner or shared mailbox, and the `sender` property returns the address of the delegate.
|
|
21951
|
+
* If the delegate has both **Send on behalf** and **Send as** permissions, the **Send as** permission applies. For information about mailbox delegation, see
|
|
21554
21952
|
* {@link https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients | Manage permissions for recipients in Exchange Online}.
|
|
21555
21953
|
*
|
|
21556
21954
|
* - The `recipientType` property of the `EmailAddressDetails` object in the `sender` property is undefined.
|
|
@@ -23341,7 +23739,7 @@ declare namespace Office {
|
|
|
23341
23739
|
*
|
|
23342
23740
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
23343
23741
|
*
|
|
23344
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23742
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23345
23743
|
*
|
|
23346
23744
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
23347
23745
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -23359,7 +23757,7 @@ declare namespace Office {
|
|
|
23359
23757
|
*
|
|
23360
23758
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
23361
23759
|
*
|
|
23362
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23760
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23363
23761
|
*
|
|
23364
23762
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
23365
23763
|
* `asyncResult`, which is an `Office.AsyncResult` object. The `value` property of the result is a `Recurrence` object.
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.676",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "f2a767b71cb5d35e435ee4f4daef7230d61dd4a50616ef5321fad1a5ac953a01",
|
|
50
50
|
"typeScriptVersion": "5.2",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|