Excel.Interfaces.ApplicationData interface
An interface describing the data returned by calling application.toJSON()
.
Properties
calculation |
Returns the Excel calculation engine version used for the last full recalculation. |
calculation |
Returns the calculation mode used in the workbook, as defined by the constants in |
calculation |
Returns the calculation state of the application. See |
culture |
Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. |
decimal |
Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings. |
format |
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. |
iterative |
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. |
thousands |
Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on the local Excel settings. |
use |
Specifies if the system separators of Excel are enabled. System separators include the decimal separator and thousands separator. |
Property Details
calculationEngineVersion
Returns the Excel calculation engine version used for the last full recalculation.
calculationEngineVersion?: number;
Property Value
number
Remarks
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
calculationState
Returns the calculation state of the application. See Excel.CalculationState
for details.
calculationState?: Excel.CalculationState | "Done" | "Calculating" | "Pending";
Property Value
Excel.CalculationState | "Done" | "Calculating" | "Pending"
Remarks
cultureInfo
Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
cultureInfo?: Excel.Interfaces.CultureInfoData;
Property Value
Remarks
decimalSeparator
Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings.
decimalSeparator?: string;
Property Value
string
Remarks
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
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.IterativeCalculationData;
Property Value
Remarks
thousandsSeparator
Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on the local Excel settings.
thousandsSeparator?: string;
Property Value
string
Remarks
useSystemSeparators
Specifies if the system separators of Excel are enabled. System separators include the decimal separator and thousands separator.
useSystemSeparators?: boolean;
Property Value
boolean
Remarks
Office Add-ins