All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aspose.cells.FormulaSettings.html Maven / Gradle / Ivy

There is a newer version: 23.1
Show newest version





FormulaSettings




com.aspose.cells
Class FormulaSettings

java.lang.Object
    extended by com.aspose.cells.FormulaSettings

public class FormulaSettings 
extends java.lang.Object

Settings of formulas and calculation.


Property Getters/Setters Summary
booleangetCalculateOnOpen()
voidsetCalculateOnOpen(boolean)
           Indicates whether the application is required to perform a full calculation when the workbook is opened.
booleangetCalculateOnSave()
voidsetCalculateOnSave(boolean)
           Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
java.lang.StringgetCalculationId()
voidsetCalculationId(java.lang.String)
           Specifies the version of the calculation engine used to calculate values in the workbook.
intgetCalculationMode()
voidsetCalculationMode(int)
           Gets or sets the mode for workbook calculation in ms excel. The value of the property is CalcModeType integer constant.
booleangetEnableCalculationChain()
voidsetEnableCalculationChain(boolean)
           Whether enable calculation chain for formulas. Default is false.
booleangetEnableIterativeCalculation()
voidsetEnableIterativeCalculation(boolean)
           Indicates whether enable iterative calculation to resolve circular references.
booleangetForceFullCalculation()
voidsetForceFullCalculation(boolean)
           Indicates whether calculates all formulas every time when a calculation is triggered.
doublegetMaxChange()
voidsetMaxChange(double)
           The maximum change to resolve a circular reference.
intgetMaxIteration()
voidsetMaxIteration(int)
           The maximum iterations to resolve a circular reference.
booleangetPrecisionAsDisplayed()
voidsetPrecisionAsDisplayed(boolean)
           Whether the precision of calculated result be set as they are displayed while calculating formulas
 

Property Getters/Setters Detail

getCalculateOnOpen/setCalculateOnOpen

public boolean getCalculateOnOpen() / public void setCalculateOnOpen(boolean value)
Indicates whether the application is required to perform a full calculation when the workbook is opened. 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. 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/setCalculateOnSave

public boolean getCalculateOnSave() / public void setCalculateOnSave(boolean value)
Indicates whether recalculate the workbook before saving the document, when in manual calculation mode. 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. 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/setForceFullCalculation

public boolean getForceFullCalculation() / public void setForceFullCalculation(boolean value)
Indicates whether calculates all formulas every time when a calculation is triggered. 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. 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/setCalculationMode

public int getCalculationMode() / public void setCalculationMode(int value)
Gets or sets the mode for workbook calculation in ms excel. The value of the property is CalcModeType integer constant. 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(com.aspose.cells.CalculationOptions, boolean), Cell.calculate(com.aspose.cells.CalculationOptions), ...etc.

setCalculationMode

public void setCalculationMode(int value)
Gets or sets the mode for workbook calculation in ms excel. The value of the property is CalcModeType integer constant. 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(com.aspose.cells.CalculationOptions, boolean), Cell.calculate(com.aspose.cells.CalculationOptions), ...etc.

getCalculationId/setCalculationId

public java.lang.String getCalculationId() / public void setCalculationId(java.lang.String value)
Specifies the version of the calculation engine used to calculate values in the workbook. 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. 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/setEnableIterativeCalculation

public boolean getEnableIterativeCalculation() / public void setEnableIterativeCalculation(boolean value)
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/setMaxIteration

public int getMaxIteration() / public void setMaxIteration(int value)
The maximum iterations to resolve a circular reference.

setMaxIteration

public void setMaxIteration(int value)
The maximum iterations to resolve a circular reference.

getMaxChange/setMaxChange

public double getMaxChange() / public void setMaxChange(double value)
The maximum change to resolve a circular reference.

setMaxChange

public void setMaxChange(double value)
The maximum change to resolve a circular reference.

getPrecisionAsDisplayed/setPrecisionAsDisplayed

public boolean getPrecisionAsDisplayed() / public void setPrecisionAsDisplayed(boolean value)
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/setEnableCalculationChain

public boolean getEnableCalculationChain() / public void setEnableCalculationChain(boolean value)
Whether enable calculation chain for formulas. Default is false. 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. 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.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy