com.aspose.cells

Class FormulaSettings

java.lang.Object

com.aspose.cells.FormulaSettings

public class FormulaSettings
extends java.lang.Object

Settings of formulas and calculation.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getCalculateOnOpen() Indicates whether the application is required to perform a full calculation when the workbook is opened.
boolean	getCalculateOnSave() Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
java.lang.String	getCalculationId() Specifies the version of the calculation engine used to calculate values in the workbook.
int	getCalculationMode() Gets the mode for workbook calculation in ms excel.
boolean	getEnableCalculationChain() Whether enable calculation chain for formulas.
boolean	getEnableIterativeCalculation() Indicates whether enable iterative calculation to resolve circular references.
boolean	getForceFullCalculation() Indicates whether calculates all formulas every time when a calculation is triggered.
double	getMaxChange() The maximum change to resolve a circular reference.
int	getMaxIteration() The maximum iterations to resolve a circular reference.
boolean	getPrecisionAsDisplayed() Whether the precision of calculated result be set as they are displayed while calculating formulas
boolean	getPreservePaddingSpaces() Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas.
void	setCalculateOnOpen(boolean value) Indicates whether the application is required to perform a full calculation when the workbook is opened.
void	setCalculateOnSave(boolean value) Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
void	setCalculationId(java.lang.String value) Specifies the version of the calculation engine used to calculate values in the workbook.
void	setCalculationMode(int value) Sets the mode for workbook calculation in ms excel.
void	setEnableCalculationChain(boolean value) Whether enable calculation chain for formulas.
void	setEnableIterativeCalculation(boolean value) Indicates whether enable iterative calculation to resolve circular references.
void	setForceFullCalculation(boolean value) Indicates whether calculates all formulas every time when a calculation is triggered.
void	setMaxChange(double value) The maximum change to resolve a circular reference.
void	setMaxIteration(int value) The maximum iterations to resolve a circular reference.
void	setPrecisionAsDisplayed(boolean value) Whether the precision of calculated result be set as they are displayed while calculating formulas
void	setPreservePaddingSpaces(boolean value) Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCalculateOnOpen

public boolean getCalculateOnOpen()

Indicates whether the application is required to perform a full calculation when the workbook is opened.

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

public void setCalculateOnOpen(boolean value)

Indicates whether the application is required to perform a full calculation when the workbook is opened.

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

public boolean getCalculateOnSave()

Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.

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

public void setCalculateOnSave(boolean value)

Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.

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

public boolean getForceFullCalculation()

Indicates whether calculates all formulas every time when a calculation is triggered.

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

public void setForceFullCalculation(boolean value)

Indicates whether calculates all formulas every time when a calculation is triggered.

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

public int getCalculationMode()

Gets the mode for workbook calculation in ms excel.

See CalcModeType.

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,boolean), Cell.calculate(CalculationOptions), ...etc.

setCalculationMode

public void setCalculationMode(int value)

Sets the mode for workbook calculation in ms excel.

See CalcModeType.

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,boolean), Cell.calculate(CalculationOptions), ...etc.

getCalculationId

public java.lang.String getCalculationId()

Specifies the version of the calculation engine used to calculate values in the workbook.

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

public void setCalculationId(java.lang.String value)

Specifies the version of the calculation engine used to calculate values in the workbook.

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

public boolean getEnableIterativeCalculation()

Indicates whether enable iterative calculation to resolve circular references.

setEnableIterativeCalculation

public void setEnableIterativeCalculation(boolean value)

Indicates whether enable iterative calculation to resolve circular references.

getMaxIteration

public int getMaxIteration()

The maximum iterations to resolve a circular reference.

setMaxIteration

public void setMaxIteration(int value)

The maximum iterations to resolve a circular reference.

getMaxChange

public double getMaxChange()

The maximum change to resolve a circular reference.

setMaxChange

public void setMaxChange(double value)

The maximum change to resolve a circular reference.

getPrecisionAsDisplayed

public boolean getPrecisionAsDisplayed()

Whether the precision of calculated result be set as they are displayed while calculating formulas

setPrecisionAsDisplayed

public void setPrecisionAsDisplayed(boolean value)

Whether the precision of calculated result be set as they are displayed while calculating formulas

getEnableCalculationChain

public boolean getEnableCalculationChain()

Whether enable calculation chain for formulas. Default is false.

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

public void setEnableCalculationChain(boolean value)

Whether enable calculation chain for formulas. Default is false.

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

public boolean getPreservePaddingSpaces()

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

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

public void setPreservePaddingSpaces(boolean value)

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

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.