com.aspose.cells

Class FormulaParseOptions

java.lang.Object

com.aspose.cells.FormulaParseOptions

public class FormulaParseOptions
extends java.lang.Object

Represents options when parsing formula.

Constructor Summary

Constructors

Constructor and Description
FormulaParseOptions()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getCheckAddIn() Whether check addins in existing external links of current workbook for user defined function without external link.
CustomFunctionDefinition	getCustomFunctionDefinition() Definition for parsing custom functions.
boolean	getLocaleDependent() Whether the formula is locale formatted.
boolean	getParse() Whether parse given formula.
boolean	getR1C1Style() Whether the formula is R1C1 reference style.
void	setCheckAddIn(boolean value) Whether check addins in existing external links of current workbook for user defined function without external link.
void	setCustomFunctionDefinition(CustomFunctionDefinition value) Definition for parsing custom functions.
void	setLocaleDependent(boolean value) Whether the formula is locale formatted.
void	setParse(boolean value) Whether parse given formula.
void	setR1C1Style(boolean value) Whether the formula is R1C1 reference style.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormulaParseOptions

public FormulaParseOptions()

Method Detail

getLocaleDependent

public boolean getLocaleDependent()

Whether the formula is locale formatted. Default is false.

setLocaleDependent

public void setLocaleDependent(boolean value)

Whether the formula is locale formatted. Default is false.

getR1C1Style

public boolean getR1C1Style()

Whether the formula is R1C1 reference style. Default is false.

setR1C1Style

public void setR1C1Style(boolean value)

Whether the formula is R1C1 reference style. Default is false.

getCheckAddIn

public boolean getCheckAddIn()

Whether check addins in existing external links of current workbook for user defined function without external link. Default is true(if user defined function matches one addin in existing external links, then take it as the addin).

setCheckAddIn

public void setCheckAddIn(boolean value)

Whether check addins in existing external links of current workbook for user defined function without external link. Default is true(if user defined function matches one addin in existing external links, then take it as the addin).

getParse

public boolean getParse()

Whether parse given formula. Default is true. If it is false, then given formula string will be kept as it is for the cell until user call other methods to parse them or parsed formula data is required by other operations such as calculating formulas.

setParse

public void setParse(boolean value)

Whether parse given formula. Default is true. If it is false, then given formula string will be kept as it is for the cell until user call other methods to parse them or parsed formula data is required by other operations such as calculating formulas.

getCustomFunctionDefinition

public CustomFunctionDefinition getCustomFunctionDefinition()

Definition for parsing custom functions.

Remarks

For some special requirements, such as when calculating custom function in user's custom engine, some parameters of it need to be caculated in array mode, using this property can mark those parameters as array mode when parsing the formula. Otherwise user needs to update those custom functions later by Workbook.updateCustomFunctionDefinition(CustomFunctionDefinition) to get the same result.

setCustomFunctionDefinition

public void setCustomFunctionDefinition(CustomFunctionDefinition value)

Definition for parsing custom functions.

Remarks

For some special requirements, such as when calculating custom function in user's custom engine, some parameters of it need to be caculated in array mode, using this property can mark those parameters as array mode when parsing the formula. Otherwise user needs to update those custom functions later by Workbook.updateCustomFunctionDefinition(CustomFunctionDefinition) to get the same result.