FormulaParseOptions
FormulaParseOptions class
Represents options when parsing formula.
class FormulaParseOptions;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Default Constructor. |
Properties
| Property | Type | Description |
|---|---|---|
| localeDependent | boolean | Whether the formula is locale formatted. Default is false. |
| r1C1Style | boolean | Whether the formula is R1C1 reference style. Default is false. |
| checkAddIn | boolean | 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). |
| parse | boolean | 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. |
| customFunctionDefinition | CustomFunctionDefinition | Definition for parsing custom functions. |
Methods
| Method | Description |
|---|---|
| getLocaleDependent() | @deprecated. Please use the ’localeDependent’ property instead. Whether the formula is locale formatted. Default is false. |
| setLocaleDependent(boolean) | @deprecated. Please use the ’localeDependent’ property instead. Whether the formula is locale formatted. Default is false. |
| getR1C1Style() | @deprecated. Please use the ‘r1C1Style’ property instead. Whether the formula is R1C1 reference style. Default is false. |
| setR1C1Style(boolean) | @deprecated. Please use the ‘r1C1Style’ property instead. Whether the formula is R1C1 reference style. Default is false. |
| getCheckAddIn() | @deprecated. Please use the ‘checkAddIn’ property instead. 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(boolean) | @deprecated. Please use the ‘checkAddIn’ property instead. 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() | @deprecated. Please use the ‘parse’ property instead. 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(boolean) | @deprecated. Please use the ‘parse’ property instead. 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() | @deprecated. Please use the ‘customFunctionDefinition’ property instead. Definition for parsing custom functions. |
| setCustomFunctionDefinition(CustomFunctionDefinition) | @deprecated. Please use the ‘customFunctionDefinition’ property instead. Definition for parsing custom functions. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Default Constructor.
constructor();
localeDependent
Whether the formula is locale formatted. Default is false.
localeDependent : boolean;
r1C1Style
Whether the formula is R1C1 reference style. Default is false.
r1C1Style : boolean;
checkAddIn
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).
checkAddIn : boolean;
parse
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.
parse : boolean;
customFunctionDefinition
Definition for parsing custom functions.
customFunctionDefinition : CustomFunctionDefinition;
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.
getLocaleDependent()
@deprecated. Please use the ’localeDependent’ property instead. Whether the formula is locale formatted. Default is false.
getLocaleDependent() : boolean;
setLocaleDependent(boolean)
@deprecated. Please use the ’localeDependent’ property instead. Whether the formula is locale formatted. Default is false.
setLocaleDependent(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getR1C1Style()
@deprecated. Please use the ‘r1C1Style’ property instead. Whether the formula is R1C1 reference style. Default is false.
getR1C1Style() : boolean;
setR1C1Style(boolean)
@deprecated. Please use the ‘r1C1Style’ property instead. Whether the formula is R1C1 reference style. Default is false.
setR1C1Style(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getCheckAddIn()
@deprecated. Please use the ‘checkAddIn’ property instead. 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).
getCheckAddIn() : boolean;
setCheckAddIn(boolean)
@deprecated. Please use the ‘checkAddIn’ property instead. 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(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getParse()
@deprecated. Please use the ‘parse’ property instead. 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.
getParse() : boolean;
setParse(boolean)
@deprecated. Please use the ‘parse’ property instead. 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(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getCustomFunctionDefinition()
@deprecated. Please use the ‘customFunctionDefinition’ property instead. Definition for parsing custom functions.
getCustomFunctionDefinition() : CustomFunctionDefinition;
Returns
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(CustomFunctionDefinition)
@deprecated. Please use the ‘customFunctionDefinition’ property instead. Definition for parsing custom functions.
setCustomFunctionDefinition(value: CustomFunctionDefinition) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CustomFunctionDefinition | The value to set. |
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.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;