CalculationOptions (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.CalculationOptions

public class CalculationOptions
extends java.lang.Object

Represents options for calculation.

Constructor Summary

Constructors
Constructor and Description

CalculationOptions()

Constructors
Constructor and Description
`CalculationOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getCalcStackSize()` The stack size for calculating cells recursively.
`AbstractCalculationMonitor`	`getCalculationMonitor()` The monitor for user to track the progress of formula calculation.
`Encoding`	`getCharacterEncoding()` Specifies the encoding used for encoding/decoding characters when calculating formulas.
`AbstractCalculationEngine`	`getCustomEngine()` The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.
`boolean`	`getIgnoreError()` Indicates whether errors encountered while calculating formulas should be ignored.
`Workbook[]`	`getLinkedDataSources()` Specifies the data sources for external links used in formulas.
`int`	`getPrecisionStrategy()` Specifies the strategy for processing precision of calculation.
`boolean`	`getRecursive()` Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells.
`boolean`	`getRefreshDynamicArrayFormula()` Indicates whether dynamic array formulas should be refreshed before calculating formulas.
`boolean`	`getUserSpecifiedRefreshDynamicArrayFormula()` Indicates whether user has explicitly specified the behavior of refreshing dynamic array formulas before calculating specified formulas.
`void`	`setCalcStackSize(int value)` The stack size for calculating cells recursively.
`void`	`setCalculationMonitor(AbstractCalculationMonitor value)` The monitor for user to track the progress of formula calculation.
`void`	`setCharacterEncoding(Encoding value)` Specifies the encoding used for encoding/decoding characters when calculating formulas.
`void`	`setCustomEngine(AbstractCalculationEngine value)` The custom formula calculation engine to extend the default calculation engine of Aspose.Cells.
`void`	`setIgnoreError(boolean value)` Indicates whether errors encountered while calculating formulas should be ignored.
`void`	`setLinkedDataSources(Workbook[] value)` Specifies the data sources for external links used in formulas.
`void`	`setPrecisionStrategy(int value)` Specifies the strategy for processing precision of calculation.
`void`	`setRecursive(boolean value)` Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells.
`void`	`setRefreshDynamicArrayFormula(boolean value)` Indicates whether dynamic array formulas should be refreshed before calculating formulas.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CalculationOptions
```
public CalculationOptions()
```
- Method Detail
  - 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.
  - setIgnoreError
```
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.
  - 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.
  - 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 is true.
  - getUserSpecifiedRefreshDynamicArrayFormula
```
public boolean getUserSpecifiedRefreshDynamicArrayFormula()
```
    Indicates whether user has explicitly specified the behavior of refreshing dynamic array formulas before calculating specified formulas.
  - getRefreshDynamicArrayFormula
```
public boolean getRefreshDynamicArrayFormula()
```
    Indicates whether dynamic array formulas should be refreshed before calculating formulas.
    Remarks
    If this property has been specified explicitly, then the specified value will be used to determine whether refresh dynamic array formulas. Otherwise(getUserSpecifiedRefreshDynamicArrayFormula() is flase), the default value of it depends on what kind of formulas need to be calculated: For calculating formulas for the workbook, such as Workbook.calculateFormula(CalculationOptions), this property will be taken as true. For other cases, such as Cell.calculate(CalculationOptions) or Worksheet.calculateFormula(CalculationOptions,boolean), this property will be taken as false.
  - setRefreshDynamicArrayFormula
```
public void setRefreshDynamicArrayFormula(boolean value)
```
    Indicates whether dynamic array formulas should be refreshed before calculating formulas.
    Remarks
    If this property has been specified explicitly, then the specified value will be used to determine whether refresh dynamic array formulas. Otherwise(getUserSpecifiedRefreshDynamicArrayFormula() is flase), the default value of it depends on what kind of formulas need to be calculated: For calculating formulas for the workbook, such as Workbook.calculateFormula(CalculationOptions), this property will be taken as true. For other cases, such as Cell.calculate(CalculationOptions) or Worksheet.calculateFormula(CalculationOptions,boolean), this property will be taken as false.
  - getCustomEngine
```
public AbstractCalculationEngine getCustomEngine()
```
    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
```
public AbstractCalculationMonitor getCalculationMonitor()
```
    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
```
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.
  - setCalcStackSize
```
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.
  - getPrecisionStrategy
```
public int getPrecisionStrategy()
```
    Specifies the strategy for processing precision of calculation.
    See CalculationPrecisionStrategy.
  - setPrecisionStrategy
```
public void setPrecisionStrategy(int value)
```
    Specifies the strategy for processing precision of calculation.
    See CalculationPrecisionStrategy.
  - 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.
  - setLinkedDataSources
```
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.
  - 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.
  - setCharacterEncoding
```
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.

Class CalculationOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CalculationOptions

Method Detail

getIgnoreError

setIgnoreError

getRecursive

setRecursive

getUserSpecifiedRefreshDynamicArrayFormula

getRefreshDynamicArrayFormula

setRefreshDynamicArrayFormula

getCustomEngine

setCustomEngine

getCalculationMonitor

setCalculationMonitor

getCalcStackSize

setCalcStackSize

getPrecisionStrategy

setPrecisionStrategy

getLinkedDataSources

setLinkedDataSources

getCharacterEncoding

setCharacterEncoding