Edit

Share via

Excel.Interfaces.ApplicationUpdateData interface

  • Reference
Package:
excel

An interface for updating data on the Application object, for use in application.set({ ... }).

Properties

calculationMode

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.
formatStaleValues

Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled. The stale formulas are rendered with stale formatting if the option is enabled.
iterativeCalculation

Returns the iterative calculation settings. In Excel on Windows and Mac, the settings will apply to the Excel Application. In Excel on the web and other platforms, the settings will apply to the active workbook.

Property Details

calculationMode

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.

calculationMode?: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";

Property Value

Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"

Remarks

[ API set: ExcelApi 1.1 for get, 1.8 for set ]

formatStaleValues

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled. The stale formulas are rendered with stale formatting if the option is enabled.

formatStaleValues?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

iterativeCalculation

Returns the iterative calculation settings. In Excel on Windows and Mac, the settings will apply to the Excel Application. In Excel on the web and other platforms, the settings will apply to the active workbook.

iterativeCalculation?: Excel.Interfaces.IterativeCalculationUpdateData;

Property Value

Excel.Interfaces.IterativeCalculationUpdateData

Remarks

[ API set: ExcelApi 1.9 ]