Excel.Interfaces.ApplicationData interface

Package:

excel

An interface describing the data returned by calling application.toJSON().

Properties

calculationEngineVersion	Returns the Excel calculation engine version used for the last full recalculation.
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.
calculationState	Returns the calculation state of the application. See Excel.CalculationState for details.
cultureInfo	Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.
decimalSeparator	Gets the string used as the decimal separator for numeric values. This is based on the local Excel settings.
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.
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.
useSystemSeparators	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

[ API set: ExcelApi 1.9 ]

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 ]

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

[ API set: ExcelApi 1.9 ]

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

Excel.Interfaces.CultureInfoData

Remarks

[ API set: ExcelApi 1.11 ]

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

[ API set: ExcelApi 1.11 ]

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

Excel.Interfaces.IterativeCalculationData

Remarks

[ API set: ExcelApi 1.9 ]

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

[ API set: ExcelApi 1.11 ]

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

[ API set: ExcelApi 1.11 ]