Edit

Share via

Excel.Interfaces.ApplicationLoadOptions interface

  • Reference
Package:
excel

Represents the Excel application that manages the workbook.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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.
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.
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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

calculationEngineVersion

Returns the Excel calculation engine version used for the last full recalculation.

calculationEngineVersion?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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.CultureInfoLoadOptions;

Property Value

Excel.Interfaces.CultureInfoLoadOptions

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.11 ]

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.IterativeCalculationLoadOptions;

Property Value

Excel.Interfaces.IterativeCalculationLoadOptions

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?: boolean;

Property Value

boolean

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 ]