Skip to content

Commit 851387e

Browse files
authored
[office-js] [office-js-preview] (Excel) Add clarifying notes (DefinitelyTyped#74413)
1 parent eb8356f commit 851387e

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

types/office-js-preview/index.d.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40142,6 +40142,7 @@ declare namespace Excel {
4014240142
readonly calculationEngineVersion: number;
4014340143
/**
4014440144
* Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it.
40145+
* This is a runtime property. The `calculationMode` setting is not persisted in the workbook.
4014540146
*
4014640147
* @remarks
4014740148
* [Api set: ExcelApi 1.1 for get, 1.8 for set]
@@ -40815,13 +40816,12 @@ declare namespace Excel {
4081540816
* Inserts the specified worksheets from a source workbook into the current workbook.
4081640817

4081740818
The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy."
40818-
40819-
**Note**: This API is currently only supported for Office on Windows, Mac, and the web.
4082040819
*
4082140820
* @remarks
4082240821
* [Api set: ExcelApi 1.13]
4082340822
*
4082440823
* This API is currently only supported for Office on Windows, Mac, and the web.
40824+
* In Excel on the web, this API doesn't support inserting charts, comments, PivotTables, or slicers.
4082540825
*
4082640826
* @param base64File Required. The Base64-encoded string representing the source workbook file.
4082740827
* @param options Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook.
@@ -41289,6 +41289,7 @@ declare namespace Excel {
4128941289
evaluate(name: string): OfficeExtension.ClientResult<any>;
4129041290
/**
4129141291
* Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.
41292+
* Content in hidden worksheets is not returned.
4129241293
*
4129341294
* @remarks
4129441295
* [Api set: ExcelApi 1.9]
@@ -41300,6 +41301,7 @@ declare namespace Excel {
4130041301
findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;
4130141302
/**
4130241303
* Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.
41304+
* Content in hidden worksheets is not returned.
4130341305
*
4130441306
* @remarks
4130541307
* [Api set: ExcelApi 1.9]
@@ -74574,6 +74576,7 @@ declare namespace Excel {
7457474576
iterativeCalculation?: Excel.Interfaces.IterativeCalculationUpdateData;
7457574577
/**
7457674578
* Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it.
74579+
* This is a runtime property. The `calculationMode` setting is not persisted in the workbook.
7457774580
*
7457874581
* @remarks
7457974582
* [Api set: ExcelApi 1.1 for get, 1.8 for set]
@@ -80452,6 +80455,7 @@ declare namespace Excel {
8045280455
calculationEngineVersion?: number;
8045380456
/**
8045480457
* Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it.
80458+
* This is a runtime property. The `calculationMode` setting is not persisted in the workbook.
8045580459
*
8045680460
* @remarks
8045780461
* [Api set: ExcelApi 1.1 for get, 1.8 for set]
@@ -88620,6 +88624,7 @@ declare namespace Excel {
8862088624
calculationEngineVersion?: boolean;
8862188625
/**
8862288626
* Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it.
88627+
* This is a runtime property. The `calculationMode` setting is not persisted in the workbook.
8862388628
*
8862488629
* @remarks
8862588630
* [Api set: ExcelApi 1.1 for get, 1.8 for set]

types/office-js/index.d.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35796,6 +35796,7 @@ declare namespace Excel {
3579635796
readonly calculationEngineVersion: number;
3579735797
/**
3579835798
* Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it.
35799+
* This is a runtime property. The `calculationMode` setting is not persisted in the workbook.
3579935800
*
3580035801
* @remarks
3580135802
* [Api set: ExcelApi 1.1 for get, 1.8 for set]
@@ -36349,13 +36350,12 @@ declare namespace Excel {
3634936350
* Inserts the specified worksheets from a source workbook into the current workbook.
3635036351

3635136352
The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy."
36352-
36353-
**Note**: This API is currently only supported for Office on Windows, Mac, and the web.
3635436353
*
3635536354
* @remarks
3635636355
* [Api set: ExcelApi 1.13]
3635736356
*
3635836357
* This API is currently only supported for Office on Windows, Mac, and the web.
36358+
* In Excel on the web, this API doesn't support inserting charts, comments, PivotTables, or slicers.
3635936359
*
3636036360
* @param base64File Required. The Base64-encoded string representing the source workbook file.
3636136361
* @param options Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook.
@@ -36815,6 +36815,7 @@ declare namespace Excel {
3681536815
evaluate(name: string): OfficeExtension.ClientResult<any>;
3681636816
/**
3681736817
* Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.
36818+
* Content in hidden worksheets is not returned.
3681836819
*
3681936820
* @remarks
3682036821
* [Api set: ExcelApi 1.9]
@@ -36826,6 +36827,7 @@ declare namespace Excel {
3682636827
findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;
3682736828
/**
3682836829
* Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.
36830+
* Content in hidden worksheets is not returned.
3682936831
*
3683036832
* @remarks
3683136833
* [Api set: ExcelApi 1.9]
@@ -69455,6 +69457,7 @@ declare namespace Excel {
6945569457
iterativeCalculation?: Excel.Interfaces.IterativeCalculationUpdateData;
6945669458
/**
6945769459
* Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it.
69460+
* This is a runtime property. The `calculationMode` setting is not persisted in the workbook.
6945869461
*
6945969462
* @remarks
6946069463
* [Api set: ExcelApi 1.1 for get, 1.8 for set]
@@ -74992,6 +74995,7 @@ declare namespace Excel {
7499274995
calculationEngineVersion?: number;
7499374996
/**
7499474997
* Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it.
74998+
* This is a runtime property. The `calculationMode` setting is not persisted in the workbook.
7499574999
*
7499675000
* @remarks
7499775001
* [Api set: ExcelApi 1.1 for get, 1.8 for set]
@@ -82545,6 +82549,7 @@ declare namespace Excel {
8254582549
calculationEngineVersion?: boolean;
8254682550
/**
8254782551
* Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`. Possible values are: `Automatic`, where Excel controls recalculation; `AutomaticExceptTables`, where Excel controls recalculation but ignores changes in tables; `Manual`, where calculation is done when the user requests it.
82552+
* This is a runtime property. The `calculationMode` setting is not persisted in the workbook.
8254882553
*
8254982554
* @remarks
8255082555
* [Api set: ExcelApi 1.1 for get, 1.8 for set]

0 commit comments

Comments
 (0)