FormulaParseOptions

Inheritance: java.lang.Object

public class FormulaParseOptions

Represents options when parsing formula.

Constructors

ConstructorDescription
FormulaParseOptions()

Methods

MethodDescription
equals(Object arg0)
getCheckAddIn()Whether check addins in existing external links of current workbook for user defined function without external link.
getClass()
getCustomFunctionDefinition()Definition for parsing custom functions.
getLocaleDependent()Whether the formula is locale formatted.
getParse()Whether parse given formula.
getR1C1Style()Whether the formula is R1C1 reference style.
hashCode()
notify()
notifyAll()
setCheckAddIn(boolean value)Whether check addins in existing external links of current workbook for user defined function without external link.
setCustomFunctionDefinition(CustomFunctionDefinition value)Definition for parsing custom functions.
setLocaleDependent(boolean value)Whether the formula is locale formatted.
setParse(boolean value)Whether parse given formula.
setR1C1Style(boolean value)Whether the formula is R1C1 reference style.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

FormulaParseOptions()

public FormulaParseOptions()

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

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).

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

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.

Returns: CustomFunctionDefinition

getLocaleDependent()

public boolean getLocaleDependent()

Whether the formula is locale formatted. Default is false.

Returns: boolean

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.

Returns: boolean

getR1C1Style()

public boolean getR1C1Style()

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

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCheckAddIn(boolean value)

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).

Parameters:

ParameterTypeDescription
valueboolean

setCustomFunctionDefinition(CustomFunctionDefinition value)

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.

Parameters:

ParameterTypeDescription
valueCustomFunctionDefinition

setLocaleDependent(boolean value)

public void setLocaleDependent(boolean value)

Whether the formula is locale formatted. Default is false.

Parameters:

ParameterTypeDescription
valueboolean

setParse(boolean value)

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.

Parameters:

ParameterTypeDescription
valueboolean

setR1C1Style(boolean value)

public void setR1C1Style(boolean value)

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

Parameters:

ParameterTypeDescription
valueboolean

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int