Class Formula

Represents a formula for a cell or group of cells.

Formulas provide a way to show dynamic values in a cell. The value could be based any number of factors, such as the values of other cells and the time of day. Those alternate cells can even exist in different workbook files on the user's machine or on the internet.

See Microsoft Excel help for more information on formulas.

Use one of the Parse or TryParse overloads to create a new formula.

Hierarchy

Base
- Formula
  - ArrayFormula

Constructors

constructor

new Formula(a, b, c): Formula
Overrides Base.constructor
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6499
Parameters
- a: number
- b: number
- c: FormulaType
Returns Formula
new Formula(a, b): Formula
Overrides Base.constructor
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6500
Parameters
- a: number
- b: ArrayFormula
Returns Formula
new Formula(a, b): Formula
Overrides Base.constructor
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6501
Parameters
- a: number
- b: WorksheetDataTable
Returns Formula
new Formula(a, b, c?): Formula
Overrides Base.constructor
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6502
Parameters
- a: number
- b: Formula
- Optional c: boolean
Returns Formula
new Formula(a, ..._rest): Formula
Overrides Base.constructor
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6503
Parameters
- a: number
- Rest ..._rest: any[]
Returns Formula

Properties

$type

$type: Type

`Static` $t

$t: Type

`Static` nextHashCode

nextHashCode: number

Methods

applyTo

applyTo(regions): void
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6547
Applies the formula to all specified regions of cells.

This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula.

After this method returns, the [[WorksheetCell.formula]] of all cells in all specified regions will return the formula.
Throws
[[ArgumentNullException]] 'regions' is null.

Throws
[[ArgumentException]] 'regions' has a length of 0.

Throws
[[ArgumentException]] Not all regions specified are from the same worksheet.

Throws
[[InvalidOperationException]] One or more regions specified contain array formulas or data tables which extend outside the region.

See
- [[applyTo]]
- [[applyTo]]
- [[WorksheetCell.applyFormula]]
- [[WorksheetRegion.applyFormula]]
Parameters
- regions: WorksheetRegion[]
  The regions of cells to apply the formula to.
Returns void
applyTo(cell): void
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6566
Applies the formula to the specified cell.

This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula.

After this method returns, the [[WorksheetCell.formula]] of the specified cell will return the formula.
Throws
[[ArgumentNullException]] 'cell' is null.

Throws
[[InvalidOperationException]] 'cell' is part of an array formula or data table which is not confined to just the cell.

See
- [[WorksheetCell.value]]
- [[applyTo]]
- [[applyTo]]
- [[WorksheetCell.applyFormula]]
- [[WorksheetRegion.applyFormula]]
- [[WorksheetRegion.applyArrayFormula]]
Parameters
- cell: WorksheetCell
  The cell to apply the formula to.
Returns void
applyTo(region): void
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6585
Applies the formula to the specified region of cells.

This method, or one of the other ApplyTo overrides must be used to set the value of a cell to a formula.

After this method returns, the [[WorksheetCell.formula]] of all cells in the specified region will return the formula.
Throws
[[ArgumentNullException]] 'region' is null.

Throws
[[InvalidOperationException]] 'region' contains an array formula or data table which extends outside the region.

See
- [[applyTo]]
- [[applyTo]]
- [[WorksheetCell.applyFormula]]
- [[WorksheetRegion.applyFormula]]
- [[WorksheetRegion.applyArrayFormula]]
Parameters
- region: WorksheetRegion
  The region of cells to apply the formula to.
Returns void

equals

equals(other): boolean
Inherited from Base.equals
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:10
Parameters
- other: any
Returns boolean

getHashCode

getHashCode(): number
Inherited from Base.getHashCode
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:17
Returns number

memberwiseClone

memberwiseClone(): Base
Inherited from Base.memberwiseClone
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:19
Returns Base

toString

toString(): string
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6510
Converts the formula to a string representation, similar to the string with which it was created. This uses the [[CellReferenceMode]] with which the formula was created to create cell reference strings.

Returns string
toString(cellReferenceMode): string
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6516
Converts the formula to a string representation, similar to the string with which it was created.

Parameters
- cellReferenceMode: CellReferenceMode
  The cell reference mode used to create cell reference strings.
Returns string
toString(cellReferenceMode, culture): string
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6523
Converts the formula to a string representation, similar to the string with which it was created.

Parameters
- cellReferenceMode: CellReferenceMode
  The cell reference mode used to create cell reference strings.
- culture: string | CultureInfo
  The culture used to generate the formula string.
Returns string

`Static` areEqual

areEqual(formulaA, formulaB, cellReferenceMode): boolean
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6766
Determines whether two [[Formula]] instances are equal using the specified cell reference mode. This essentially performs a case-insensitive string comparison, ignoring the white space in the formula.

Parameters
- formulaA: Formula
  The first Formula to compare.
- formulaB: Formula
  The second Formula to compare.
- cellReferenceMode: CellReferenceMode
  The cell reference mode to use when comparing the two formulas.
Returns boolean

`Static` compare

compare(item1, item2): number
Inherited from Base.compare
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:14
Parameters
- item1: any
- item2: any
Returns number

`Static` compareSimple

compareSimple(item1, item2): number
Inherited from Base.compareSimple
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:13
Parameters
- item1: any
- item2: any
Returns number

`Static` equalsSimple

equalsSimple(item1, item2): boolean
Inherited from Base.equalsSimple
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:12
Parameters
- item1: any
- item2: any
Returns boolean

`Static` equalsStatic

equalsStatic(a, b): boolean
Inherited from Base.equalsStatic
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:11
Parameters
- a: any
- b: any
Returns boolean

`Static` getArrayOfProperties

getArrayOfProperties(obj): any[]
Inherited from Base.getArrayOfProperties
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:22
Parameters
- obj: any
Returns any[]

`Static` getArrayOfValues

getArrayOfValues(obj): any[]
Inherited from Base.getArrayOfValues
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:21
Parameters
- obj: any
Returns any[]

`Static` getHashCodeStatic

getHashCodeStatic(obj): number
Inherited from Base.getHashCodeStatic
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:18
Parameters
- obj: any
Returns number

`Static` parse

parse(value, cellReferenceMode): Formula
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6780
Parses the specified formula value and returns the formula which was created from it.

Throws
[[ArgumentNullException]] 'value' is null or empty.

Throws
[[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration.

Throws
[[FormulaParseException]] 'value' is not a valid formula.

Parameters
- value: string
  The string which defines the formula to parse.
- cellReferenceMode: CellReferenceMode
  The mode used to interpret cell references in the formula.
Returns Formula
parse(value, cellReferenceMode, fileFormat): Formula
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6792
Parses the specified formula value and returns the formula which was created from it.

Throws
[[ArgumentNullException]] 'value' is null or empty.

Throws
[[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration.

Throws
[[InvalidEnumArgumentException]] 'fileFormat' is not defined in the [[WorkbookFormat]] enumeration.

Throws
[[FormulaParseException]] 'value' is not a valid formula.

Parameters
- value: string
  The string which defines the formula to parse.
- cellReferenceMode: CellReferenceMode
  The mode used to interpret cell references in the formula.
- fileFormat: WorkbookFormat
  The file format to use when parsing the formula. This will be used to determine certain limits which are format dependant.
Returns Formula
parse(value, cellReferenceMode, fileFormat, culture): Formula
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6805
Parses the specified formula value and returns the formula which was created from it.

Throws
[[ArgumentNullException]] 'value' is null or empty.

Throws
[[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration.

Throws
[[InvalidEnumArgumentException]] 'fileFormat' is not defined in the [[WorkbookFormat]] enumeration.

Throws
[[FormulaParseException]] 'value' is not a valid formula.

Parameters
- value: string
  The string which defines the formula to parse.
- cellReferenceMode: CellReferenceMode
  The mode used to interpret cell references in the formula.
- fileFormat: WorkbookFormat
  The file format to use when parsing the formula. This will be used to determine certain limits which are format dependant.
- culture: string | CultureInfo
  The culture used to parse the formula.
Returns Formula
parse(value, cellReferenceMode, culture): Formula
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6816
Parses the specified formula value and returns the formula which was created from it.

Throws
[[ArgumentNullException]] 'value' is null or empty.

Throws
[[InvalidEnumArgumentException]] 'cellReferenceMode' is not defined in the [[CellReferenceMode]] enumeration.

Throws
[[FormulaParseException]] 'value' is not a valid formula.

Parameters
- value: string
  The string which defines the formula to parse.
- cellReferenceMode: CellReferenceMode
  The mode used to interpret cell references in the formula.
- culture: string | CultureInfo
  The culture used to parse the formula.
Returns Formula

`Static` referenceEquals

referenceEquals(a, b): boolean
Inherited from Base.referenceEquals
- Defined in node_modules/igniteui-react-core/lib/type.d.ts:20
Parameters
- a: any
- b: any
Returns boolean

`Static` staticInit

staticInit(): void
- Defined in dist/igniteui-react-excel/lib/DefaultStyleHelper_combined.d.ts:6498
Returns void

Class Formula

Hierarchy

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Parameters

a: number

b: number

c: FormulaType

Returns Formula

Parameters

a: number

b: ArrayFormula

Returns Formula

Parameters

a: number

b: WorksheetDataTable

Returns Formula

Parameters

a: number

b: Formula

Optional c: boolean

Returns Formula

Parameters

a: number

Rest ..._rest: any[]

Returns Formula

Properties

$type

Static $t

Static nextHashCode

Methods

applyTo

Throws

Throws

Throws

Throws

See

Parameters

regions: WorksheetRegion[]

Returns void

Throws

Throws

See

Parameters

cell: WorksheetCell

Returns void

Throws

Throws

See

Parameters

region: WorksheetRegion

Returns void

equals

Parameters

other: any

Returns boolean

getHashCode

Returns number

memberwiseClone

Returns Base

toString

Returns string

Parameters

cellReferenceMode: CellReferenceMode

Returns string

Parameters

cellReferenceMode: CellReferenceMode

culture: string | CultureInfo

Returns string

Static areEqual

Parameters

formulaA: Formula

formulaB: Formula

cellReferenceMode: CellReferenceMode

Returns boolean

Static compare

`Static` $t

`Static` nextHashCode

`Static` areEqual

`Static` compare

`Static` compareSimple

`Static` equalsSimple

`Static` equalsStatic

`Static` getArrayOfProperties

`Static` getArrayOfValues

`Static` getHashCodeStatic

`Static` parse

`Static` referenceEquals