asposecells.api

Class CalculationOptions

Represents options for calculation.

Constructor Summary
 
Property Getters/Setters Summary
methodgetCalcStackSize()
method
           The stack size for calculating cells recursively. Default value is 200.
methodgetCalculationMonitor()
method
           The monitor for user to track the progress of formula calculation.
methodgetCharacterEncoding()
method
           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.
methodgetIgnoreError()
method
           Indicates whether errors encountered while calculating formulas should be ignored. The error may be unsupported function, external links, etc. The default value is true.
methodgetLinkedDataSources()
method
           Specifies the data sources for external links used in formulas.
methodgetPrecisionStrategy()
method
           Specifies the strategy for processing precision of calculation. The value of the property is CalculationPrecisionStrategy integer constant.
methodgetRecursive()
method
           Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. The default value is true.
 

    • Constructor Detail

      • CalculationOptions

        CalculationOptions()
    • Property Getters/Setters Detail

      • getIgnoreError/setIgnoreError : boolean 

        boolean getIgnoreError() / setIgnoreError(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/setRecursive : boolean 

        boolean getRecursive() / setRecursive(value)
        
        Indicates whether calculate the dependent cells recursively when calculating one cell and it depends on other cells. The default value is true.
      • getCalcStackSize/setCalcStackSize : int 

        int getCalcStackSize() / setCalcStackSize(value)
        
        The stack size for calculating cells recursively. Default value is 200. 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/setPrecisionStrategy : int 

        int getPrecisionStrategy() / setPrecisionStrategy(value)
        
        Specifies the strategy for processing precision of calculation. The value of the property is CalculationPrecisionStrategy integer constant.
      • getCharacterEncoding/setCharacterEncoding : Encoding 

        Encoding getCharacterEncoding() / setCharacterEncoding(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.