CalculationOptions
Inheritance: java.lang.Object
public class CalculationOptions
Represents options for calculation.
Constructors
| Constructor | Description |
|---|---|
| CalculationOptions() |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getCalcStackSize() | The stack size for calculating cells recursively. |
| getCalculationMonitor() | The monitor for user to track the progress of formula calculation. |
| getCharacterEncoding() | Specifies the encoding used for encoding/decoding characters when calculating formulas. |
| getClass() | |
| getCustomEngine() | The custom formula calculation engine to extend the default calculation engine of Aspose.Cells. |
| getIgnoreError() | Indicates whether errors encountered while calculating formulas should be ignored. |
| getLinkedDataSources() | Specifies the data sources for external links used in formulas. |
| getPrecisionStrategy() | Specifies the strategy for processing precision of calculation. |
| getRecursive() | Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setCalcStackSize(int value) | The stack size for calculating cells recursively. |
| setCalculationMonitor(AbstractCalculationMonitor value) | The monitor for user to track the progress of formula calculation. |
| setCharacterEncoding(Encoding value) | Specifies the encoding used for encoding/decoding characters when calculating formulas. |
| setCustomEngine(AbstractCalculationEngine value) | The custom formula calculation engine to extend the default calculation engine of Aspose.Cells. |
| setIgnoreError(boolean value) | Indicates whether errors encountered while calculating formulas should be ignored. |
| setLinkedDataSources(Workbook[] value) | Specifies the data sources for external links used in formulas. |
| setPrecisionStrategy(int value) | Specifies the strategy for processing precision of calculation. |
| setRecursive(boolean value) | Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
CalculationOptions()
public CalculationOptions()
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getCalcStackSize()
public int getCalcStackSize()
The stack size for calculating cells recursively. Default value is 200.
Remarks
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. However, too small value may cause performance degradation for the formula calculation and value less than 2 will make it impossible to calculate formula which depends on another one. So if the specified value is less than 2, it will be reset to 2.
Returns: int
getCalculationMonitor()
public AbstractCalculationMonitor getCalculationMonitor()
The monitor for user to track the progress of formula calculation.
Returns: AbstractCalculationMonitor
getCharacterEncoding()
public Encoding getCharacterEncoding()
Specifies the encoding used for encoding/decoding characters when calculating formulas. For functions such as CHAR, CODE, the calculated result depends on the region settings and default charset of the environment. With this property user can specify the proper encoding used for those function to get the expected result.
Returns: Encoding
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCustomEngine()
public AbstractCalculationEngine getCustomEngine()
The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.
Returns: AbstractCalculationEngine
getIgnoreError()
public boolean getIgnoreError()
Indicates whether errors encountered while calculating formulas should be ignored. The error may be unsupported function, external links, etc. The default value is true.
Returns: boolean
getLinkedDataSources()
public Workbook[] getLinkedDataSources()
Specifies the data sources for external links used in formulas.
Remarks
Like Workbook.updateLinkedDataSource(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(Workbook[]). The match of those workbooks with external links is determined by Workbook.getFileName() and ExternalLink.getDataSource(). So please make sure Workbook.getFileName() has been specified with the proper value(generally it should be same with corresponding ExternalLink.getDataSource()) for every workbook so they can be linked as expected.
Returns: com.aspose.cells.Workbook[]
getPrecisionStrategy()
public int getPrecisionStrategy()
Specifies the strategy for processing precision of calculation.
See CalculationPrecisionStrategy.
Returns: int
getRecursive()
public boolean getRecursive()
Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. The default value is true.
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setCalcStackSize(int value)
public void setCalcStackSize(int value)
The stack size for calculating cells recursively. Default value is 200.
Remarks
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. However, too small value may cause performance degradation for the formula calculation and value less than 2 will make it impossible to calculate formula which depends on another one. So if the specified value is less than 2, it will be reset to 2.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setCalculationMonitor(AbstractCalculationMonitor value)
public void setCalculationMonitor(AbstractCalculationMonitor value)
The monitor for user to track the progress of formula calculation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | AbstractCalculationMonitor |
setCharacterEncoding(Encoding value)
public void setCharacterEncoding(Encoding value)
Specifies the encoding used for encoding/decoding characters when calculating formulas. For functions such as CHAR, CODE, the calculated result depends on the region settings and default charset of the environment. With this property user can specify the proper encoding used for those function to get the expected result.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Encoding |
setCustomEngine(AbstractCalculationEngine value)
public void setCustomEngine(AbstractCalculationEngine value)
The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | AbstractCalculationEngine |
setIgnoreError(boolean value)
public void setIgnoreError(boolean value)
Indicates whether errors encountered while calculating formulas should be ignored. The error may be unsupported function, external links, etc. The default value is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setLinkedDataSources(Workbook[] value)
public void setLinkedDataSources(Workbook[] value)
Specifies the data sources for external links used in formulas.
Remarks
Like Workbook.updateLinkedDataSource(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(Workbook[]). The match of those workbooks with external links is determined by Workbook.getFileName() and ExternalLink.getDataSource(). So please make sure Workbook.getFileName() has been specified with the proper value(generally it should be same with corresponding ExternalLink.getDataSource()) for every workbook so they can be linked as expected.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Workbook[] |
setPrecisionStrategy(int value)
public void setPrecisionStrategy(int value)
Specifies the strategy for processing precision of calculation.
See CalculationPrecisionStrategy.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setRecursive(boolean value)
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 is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |