com.aspose.cells
Class CalculationOptions

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

public class CalculationOptions 
extends java.lang.Object

Represents options for calculation.


Constructor Summary
CalculationOptions()
          
 
Property Getters/Setters Summary
intgetCalcStackSize()
voidsetCalcStackSize(int)
           Specifies the stack size for calculating cells recursively.
AbstractCalculationMonitorgetCalculationMonitor()
voidsetCalculationMonitor(AbstractCalculationMonitor)
           The monitor for user to track the progress of formula calculation.
AbstractCalculationEnginegetCustomEngine()
voidsetCustomEngine(AbstractCalculationEngine)
           The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.
ICustomFunctiongetCustomFunction()
voidsetCustomFunction(ICustomFunction)
           The custom formula calculation functions to extend the calculation engine.
booleangetIgnoreError()
voidsetIgnoreError(boolean)
           Indicates if you need to hide the error in calculating formulas. The error may be unsupported function, external links, etc.
com.aspose.cells.Workbook[]getLinkedDataSources()
voidsetLinkedDataSources(com.aspose.cells.Workbook[])
           Specifies the data sources for external links used in formulas.
intgetPrecisionStrategy()
voidsetPrecisionStrategy(int)
           Specifies the strategy for processing precision of calculation. The value of the property is CalculationPrecisionStrategy integer constant.
booleangetRecursive()
voidsetRecursive(boolean)
           Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. The default value if true.
 

Constructor Detail

CalculationOptions

public CalculationOptions()

Property Getters/Setters Detail

getIgnoreError/setIgnoreError

public boolean getIgnoreError() / public void setIgnoreError(boolean value)
Indicates if you need to hide the error in calculating formulas. The error may be unsupported function, external links, etc.

setIgnoreError

public void setIgnoreError(boolean value)
Indicates if you need to hide the error in calculating formulas. The error may be unsupported function, external links, etc.

getRecursive/setRecursive

public boolean getRecursive() / public void setRecursive(boolean value)
Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. The default value if true.

setRecursive

public void setRecursive(boolean value)
Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. The default value if true.

getCustomFunction/setCustomFunction

public ICustomFunction getCustomFunction() / public void setCustomFunction(ICustomFunction value)
The custom formula calculation functions to extend the calculation engine. NOTE: This member is now obsolete. Instead, please use CustomEngine property, AbstractCalculationEngine provides more convenient and flexible APIs for manipulating custom functions. This property will be removed 12 months later since August 2020. Aspose apologizes for any inconvenience you may have experienced.

setCustomFunction

public void setCustomFunction(ICustomFunction value)
The custom formula calculation functions to extend the calculation engine. NOTE: This member is now obsolete. Instead, please use CustomEngine property, AbstractCalculationEngine provides more convenient and flexible APIs for manipulating custom functions. This property will be removed 12 months later since August 2020. Aspose apologizes for any inconvenience you may have experienced.

getCustomEngine/setCustomEngine

public AbstractCalculationEngine getCustomEngine() / public void setCustomEngine(AbstractCalculationEngine value)
The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.

setCustomEngine

public void setCustomEngine(AbstractCalculationEngine value)
The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.

getCalculationMonitor/setCalculationMonitor

public AbstractCalculationMonitor getCalculationMonitor() / public void setCalculationMonitor(AbstractCalculationMonitor value)
The monitor for user to track the progress of formula calculation.

setCalculationMonitor

public void setCalculationMonitor(AbstractCalculationMonitor value)
The monitor for user to track the progress of formula calculation.

getCalcStackSize/setCalcStackSize

public int getCalcStackSize() / public void setCalcStackSize(int value)
Specifies the stack size for calculating cells recursively. When there are large amount of cells need to be calculated recursively in the dependency tree, StackOverflowException may be caused in the calculation process. If so, user should specify smaller value for this property. For such situation, user should determine the proper value for this property according to the actual formulas and data. Too small value may cause performance degradation for the formula calculation.

setCalcStackSize

public void setCalcStackSize(int value)
Specifies the stack size for calculating cells recursively. When there are large amount of cells need to be calculated recursively in the dependency tree, StackOverflowException may be caused in the calculation process. If so, user should specify smaller value for this property. For such situation, user should determine the proper value for this property according to the actual formulas and data. Too small value may cause performance degradation for the formula calculation.

getPrecisionStrategy/setPrecisionStrategy

public int getPrecisionStrategy() / public void setPrecisionStrategy(int value)
Specifies the strategy for processing precision of calculation. The value of the property is CalculationPrecisionStrategy integer constant.

setPrecisionStrategy

public void setPrecisionStrategy(int value)
Specifies the strategy for processing precision of calculation. The value of the property is CalculationPrecisionStrategy integer constant.

getLinkedDataSources/setLinkedDataSources

public com.aspose.cells.Workbook[] getLinkedDataSources() / public void setLinkedDataSources(com.aspose.cells.Workbook[] value)
Specifies the data sources for external links used in formulas. Like Workbook.updateLinkedDataSource(com.aspose.cells.Workbook[]), here you may specify data sources for external links used in formulas to be calculated, especially those used in INDIRECT function. For those external links used in INDIRECT function, they are not taken as part of the external links of the workbook and cannot be updated by Workbook.updateLinkedDataSource(com.aspose.cells.Workbook[]).

setLinkedDataSources

public void setLinkedDataSources(com.aspose.cells.Workbook[] value)
Specifies the data sources for external links used in formulas. Like Workbook.updateLinkedDataSource(com.aspose.cells.Workbook[]), here you may specify data sources for external links used in formulas to be calculated, especially those used in INDIRECT function. For those external links used in INDIRECT function, they are not taken as part of the external links of the workbook and cannot be updated by Workbook.updateLinkedDataSource(com.aspose.cells.Workbook[]).

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