FormulaParseOptions

FormulaParseOptions class

Represents options when parsing formula.

class FormulaParseOptions;

Constructors

NameDescription
constructor()Default Constructor.

Properties

PropertyTypeDescription
localeDependentbooleanWhether the formula is locale formatted. Default is false.
r1C1StylebooleanWhether the formula is R1C1 reference style. Default is false.
checkAddInbooleanWhether 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).
parsebooleanWhether 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.
customFunctionDefinitionCustomFunctionDefinitionDefinition for parsing custom functions.

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.