FormulaSettings
Inheritance: java.lang.Object
public class FormulaSettings
Settings of formulas and calculation.
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getCalculateOnOpen() | Indicates whether the application is required to perform a full calculation when the workbook is opened. |
| getCalculateOnSave() | Indicates whether recalculate the workbook before saving the document, when in manual calculation mode. |
| getCalculationId() | Specifies the version of the calculation engine used to calculate values in the workbook. |
| getCalculationMode() | Gets the mode for workbook calculation in ms excel. |
| getClass() | |
| getEnableCalculationChain() | Whether enable calculation chain for formulas. |
| getEnableIterativeCalculation() | Indicates whether enable iterative calculation to resolve circular references. |
| getForceFullCalculation() | Indicates whether calculates all formulas every time when a calculation is triggered. |
| getMaxChange() | The maximum change to resolve a circular reference. |
| getMaxIteration() | The maximum iterations to resolve a circular reference. |
| getPrecisionAsDisplayed() | Whether the precision of calculated result be set as they are displayed while calculating formulas |
| getPreservePaddingSpaces() | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setCalculateOnOpen(boolean value) | Indicates whether the application is required to perform a full calculation when the workbook is opened. |
| setCalculateOnSave(boolean value) | Indicates whether recalculate the workbook before saving the document, when in manual calculation mode. |
| setCalculationId(String value) | Specifies the version of the calculation engine used to calculate values in the workbook. |
| setCalculationMode(int value) | Sets the mode for workbook calculation in ms excel. |
| setEnableCalculationChain(boolean value) | Whether enable calculation chain for formulas. |
| setEnableIterativeCalculation(boolean value) | Indicates whether enable iterative calculation to resolve circular references. |
| setForceFullCalculation(boolean value) | Indicates whether calculates all formulas every time when a calculation is triggered. |
| setMaxChange(double value) | The maximum change to resolve a circular reference. |
| setMaxIteration(int value) | The maximum iterations to resolve a circular reference. |
| setPrecisionAsDisplayed(boolean value) | Whether the precision of calculated result be set as they are displayed while calculating formulas |
| setPreservePaddingSpaces(boolean value) | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getCalculateOnOpen()
public boolean getCalculateOnOpen()
Indicates whether the application is required to perform a full calculation when the workbook is opened.
Remarks
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.
Returns: boolean
getCalculateOnSave()
public boolean getCalculateOnSave()
Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
Remarks
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.
Returns: boolean
getCalculationId()
public String getCalculationId()
Specifies the version of the calculation engine used to calculate values in the workbook.
Remarks
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.
Returns: java.lang.String
getCalculationMode()
public int getCalculationMode()
Gets the mode for workbook calculation in ms excel.
See CalcModeType.
Remarks
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(CalculationOptions,boolean), Cell.calculate(CalculationOptions), …etc.
Returns: int
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getEnableCalculationChain()
public boolean getEnableCalculationChain()
Whether enable calculation chain for formulas. Default is false.
Remarks
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.
Returns: boolean
getEnableIterativeCalculation()
public boolean getEnableIterativeCalculation()
Indicates whether enable iterative calculation to resolve circular references.
Returns: boolean
getForceFullCalculation()
public boolean getForceFullCalculation()
Indicates whether calculates all formulas every time when a calculation is triggered.
Remarks
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.
Returns: boolean
getMaxChange()
public double getMaxChange()
The maximum change to resolve a circular reference.
Returns: double
getMaxIteration()
public int getMaxIteration()
The maximum iterations to resolve a circular reference.
Returns: int
getPrecisionAsDisplayed()
public boolean getPrecisionAsDisplayed()
Whether the precision of calculated result be set as they are displayed while calculating formulas
Returns: boolean
getPreservePaddingSpaces()
public boolean getPreservePaddingSpaces()
Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
Remarks
Generally those spaces and line breaks are jsut for visual purpose, Preserving them or not does not affect the calculated result. For performance consideration, if there is no special requirement, it is better not to preserve them while processing formulas.
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setCalculateOnOpen(boolean value)
public void setCalculateOnOpen(boolean value)
Indicates whether the application is required to perform a full calculation when the workbook is opened.
Remarks
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setCalculateOnSave(boolean value)
public void setCalculateOnSave(boolean value)
Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.
Remarks
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setCalculationId(String value)
public void setCalculationId(String value)
Specifies the version of the calculation engine used to calculate values in the workbook.
Remarks
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCalculationMode(int value)
public void setCalculationMode(int value)
Sets the mode for workbook calculation in ms excel.
See CalcModeType.
Remarks
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(CalculationOptions,boolean), Cell.calculate(CalculationOptions), …etc.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setEnableCalculationChain(boolean value)
public void setEnableCalculationChain(boolean value)
Whether enable calculation chain for formulas. Default is false.
Remarks
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setEnableIterativeCalculation(boolean value)
public void setEnableIterativeCalculation(boolean value)
Indicates whether enable iterative calculation to resolve circular references.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setForceFullCalculation(boolean value)
public void setForceFullCalculation(boolean value)
Indicates whether calculates all formulas every time when a calculation is triggered.
Remarks
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setMaxChange(double value)
public void setMaxChange(double value)
The maximum change to resolve a circular reference.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
setMaxIteration(int value)
public void setMaxIteration(int value)
The maximum iterations to resolve a circular reference.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPrecisionAsDisplayed(boolean value)
public void setPrecisionAsDisplayed(boolean value)
Whether the precision of calculated result be set as they are displayed while calculating formulas
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPreservePaddingSpaces(boolean value)
public void setPreservePaddingSpaces(boolean value)
Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
Remarks
Generally those spaces and line breaks are jsut for visual purpose, Preserving them or not does not affect the calculated result. For performance consideration, if there is no special requirement, it is better not to preserve them while processing formulas.
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 |