FormulaSettings
FormulaSettings class
Settings of formulas and calculation.
class FormulaSettings;
Methods
| Method | Description |
|---|---|
| getCalculateOnOpen() | Indicates whether the application is required to perform a full calculation when the workbook is opened. |
| setCalculateOnOpen(boolean) | Indicates whether the application is required to perform a full calculation when the workbook is opened. |
| getCalculateOnSave() | Indicates whether recalculate the workbook before saving the document, when in manual calculation mode. |
| setCalculateOnSave(boolean) | Indicates whether recalculate the workbook before saving the document, when in manual calculation mode. |
| getForceFullCalculation() | Indicates whether calculates all formulas every time when a calculation is triggered. |
| setForceFullCalculation(boolean) | Indicates whether calculates all formulas every time when a calculation is triggered. |
| getCalculationMode() | Gets or sets the mode for workbook calculation in ms excel. |
| setCalculationMode(CalcModeType) | Gets or sets the mode for workbook calculation in ms excel. |
| getCalculationId() | Specifies the version of the calculation engine used to calculate values in the workbook. |
| setCalculationId(string) | Specifies the version of the calculation engine used to calculate values in the workbook. |
| getEnableIterativeCalculation() | Indicates whether enable iterative calculation to resolve circular references. |
| setEnableIterativeCalculation(boolean) | Indicates whether enable iterative calculation to resolve circular references. |
| getMaxIteration() | The maximum iterations to resolve a circular reference. |
| setMaxIteration(number) | The maximum iterations to resolve a circular reference. |
| getMaxChange() | The maximum change to resolve a circular reference. |
| setMaxChange(number) | The maximum change to resolve a circular reference. |
| getPrecisionAsDisplayed() | Whether the precision of calculated result be set as they are displayed while calculating formulas |
| setPrecisionAsDisplayed(boolean) | Whether the precision of calculated result be set as they are displayed while calculating formulas |
| getEnableCalculationChain() | Whether enable calculation chain for formulas. Default is false. |
| setEnableCalculationChain(boolean) | Whether enable calculation chain for formulas. Default is false. |
| getPreservePaddingSpaces() | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false. |
| setPreservePaddingSpaces(boolean) | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false. |
| isNull() | Checks whether the implementation object is null. |
getCalculateOnOpen()
Indicates whether the application is required to perform a full calculation when the workbook is opened.
getCalculateOnOpen() : boolean;
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading the resultant file. For performance consideration for most users’ applications, we do not calculate any formula in the workbook automatically, no matter what value has been set for this property.
setCalculateOnOpen(boolean)
Indicates whether the application is required to perform a full calculation when the workbook is opened.
setCalculateOnOpen(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading the resultant file. For performance consideration for most users’ applications, we do not calculate any formula in the workbook automatically, no matter what value has been set for this property.
getCalculateOnSave()
Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
getCalculateOnSave() : boolean;
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. For performance consideration for most users’ applications, we do not calculate any formula in the workbook automatically, no matter what value has been set for this property.
setCalculateOnSave(boolean)
Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
setCalculateOnSave(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. For performance consideration for most users’ applications, we do not calculate any formula in the workbook automatically, no matter what value has been set for this property.
getForceFullCalculation()
Indicates whether calculates all formulas every time when a calculation is triggered.
getForceFullCalculation() : boolean;
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. For performance consideration for most users’ applications, we do not calculate any formula in the workbook automatically, no matter what value has been set for this property.
setForceFullCalculation(boolean)
Indicates whether calculates all formulas every time when a calculation is triggered.
setForceFullCalculation(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. For performance consideration for most users’ applications, we do not calculate any formula in the workbook automatically, no matter what value has been set for this property.
getCalculationMode()
Gets or sets the mode for workbook calculation in ms excel.
getCalculationMode() : CalcModeType;
Returns
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. For performance consideration for most user’s application, we do not calculate any formula in the workbook automatically, no matter what mode has been set for this property. If user needs to calculate formulas, please always call methods on different objects according to requirement: Workbook.CalculateFormula(), [Worksheet.CalculateFormula(CalculationOptions, bool)](../worksheet.calculateformula(calculationoptions, bool)/), Cell.Calculate(CalculationOptions), …etc.
setCalculationMode(CalcModeType)
Gets or sets the mode for workbook calculation in ms excel.
setCalculationMode(value: CalcModeType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CalcModeType | The value to set. |
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. For performance consideration for most user’s application, we do not calculate any formula in the workbook automatically, no matter what mode has been set for this property. If user needs to calculate formulas, please always call methods on different objects according to requirement: Workbook.CalculateFormula(), [Worksheet.CalculateFormula(CalculationOptions, bool)](../worksheet.calculateformula(calculationoptions, bool)/), Cell.Calculate(CalculationOptions), …etc.
getCalculationId()
Specifies the version of the calculation engine used to calculate values in the workbook.
getCalculationId() : string;
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. In the case of ms excel, if the value of this property is less than the recalculation engine identifier associated with the application that opens the resultant file, the application will recalculate the results of all formulas on this workbook immediately after loading the file. For performance consideration for most users’ applications, we do not calculate any formula on the workbook automatically, no matter what value has been set for this property.
setCalculationId(string)
Specifies the version of the calculation engine used to calculate values in the workbook.
setCalculationId(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
This property is only for saving the settings to resultant spreadsheet file so that other applications(such as ms excel) may act accordingly when loading and manipulating the resultant file. In the case of ms excel, if the value of this property is less than the recalculation engine identifier associated with the application that opens the resultant file, the application will recalculate the results of all formulas on this workbook immediately after loading the file. For performance consideration for most users’ applications, we do not calculate any formula on the workbook automatically, no matter what value has been set for this property.
getEnableIterativeCalculation()
Indicates whether enable iterative calculation to resolve circular references.
getEnableIterativeCalculation() : boolean;
setEnableIterativeCalculation(boolean)
Indicates whether enable iterative calculation to resolve circular references.
setEnableIterativeCalculation(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getMaxIteration()
The maximum iterations to resolve a circular reference.
getMaxIteration() : number;
setMaxIteration(number)
The maximum iterations to resolve a circular reference.
setMaxIteration(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getMaxChange()
The maximum change to resolve a circular reference.
getMaxChange() : number;
setMaxChange(number)
The maximum change to resolve a circular reference.
setMaxChange(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getPrecisionAsDisplayed()
Whether the precision of calculated result be set as they are displayed while calculating formulas
getPrecisionAsDisplayed() : boolean;
setPrecisionAsDisplayed(boolean)
Whether the precision of calculated result be set as they are displayed while calculating formulas
setPrecisionAsDisplayed(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getEnableCalculationChain()
Whether enable calculation chain for formulas. Default is false.
getEnableCalculationChain() : boolean;
Remarks
When there are lots of formulas in the workbook and user needs to calculate them repeatedly with modifying only a small part of them, it may be helpful for performance to enable the calculation chain. On the other hand, if the chain is enabled, maintaining the model of chain requires extra memory, and it also requires a bit more cpu time for some other operations such as changing cell’s value or formulas. After changing this property from false to true, the calculation chain will be analyzed and built at the time of first calculation for the workbook, so the required time for the first calculation may be more than normal calculation without chain.
setEnableCalculationChain(boolean)
Whether enable calculation chain for formulas. Default is false.
setEnableCalculationChain(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
When there are lots of formulas in the workbook and user needs to calculate them repeatedly with modifying only a small part of them, it may be helpful for performance to enable the calculation chain. On the other hand, if the chain is enabled, maintaining the model of chain requires extra memory, and it also requires a bit more cpu time for some other operations such as changing cell’s value or formulas. After changing this property from false to true, the calculation chain will be analyzed and built at the time of first calculation for the workbook, so the required time for the first calculation may be more than normal calculation without chain.
getPreservePaddingSpaces()
Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
getPreservePaddingSpaces() : boolean;
Remarks
Generally those spaces and line breaks are jsut for visual purpose, Preserving them or not does not affect the calculated result. For performance consideration, if there is no special requirement, it is better not to preserve them while processing formulas.
setPreservePaddingSpaces(boolean)
Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
setPreservePaddingSpaces(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
Generally those spaces and line breaks are jsut for visual purpose, Preserving them or not does not affect the calculated result. For performance consideration, if there is no special requirement, it is better not to preserve them while processing formulas.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;