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: number, b: number, c: FormulaType): Formula
Overrides Base.constructor
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6491
Parameters
- a: number
- b: number
- c: FormulaType
Returns Formula
new Formula(a: number, b: ArrayFormula): Formula
Overrides Base.constructor
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6492
Parameters
- a: number
- b: ArrayFormula
Returns Formula
new Formula(a: number, b: WorksheetDataTable): Formula
Overrides Base.constructor
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6493
Parameters
- a: number
- b: WorksheetDataTable
Returns Formula
new Formula(a: number, b: Formula, c?: boolean): Formula
Overrides Base.constructor
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6494
Parameters
- a: number
- b: Formula
- Optional c: boolean
Returns Formula
new Formula(a: number, ..._rest: any[]): Formula
Overrides Base.constructor
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6495
Parameters
- a: number
- Rest ..._rest: any[]
Returns Formula

Properties

$type

$type: Type

`Static` $t

$t: Type

`Static` nextHashCode

nextHashCode: number

Methods

applyTo

applyTo(regions: WorksheetRegion[]): void
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6539
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
Parameters
- regions: WorksheetRegion[]
  
  The regions of cells to apply the formula to.
Returns void
applyTo(cell: WorksheetCell): void
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6558
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
Parameters
- cell: WorksheetCell
  
  The cell to apply the formula to.
Returns void
applyTo(region: WorksheetRegion): void
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6577
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
Parameters
- region: WorksheetRegion
  
  The region of cells to apply the formula to.
Returns void

equals

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

getHashCode

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

memberwiseClone

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

toString

toString(): string
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6502
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
The string representing the formula.

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

Returns
The string representing the formula.

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

Returns
The string representing the formula.

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: Formula, formulaB: Formula, cellReferenceMode: CellReferenceMode): boolean
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6754
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.

Returns
True if the formulas are both null or both equivalent; False otherwise.

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: any, item2: any): number
Inherited from Base.compare
- Defined in igniteui-angular-core/lib/type.d.ts:14
Parameters
- item1: any
- item2: any
Returns number

`Static` compareSimple

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

`Static` equalsSimple

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

`Static` equalsStatic

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

`Static` getArrayOfProperties

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

`Static` getArrayOfValues

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

`Static` getHashCodeStatic

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

`Static` parse

parse(value: string, cellReferenceMode: CellReferenceMode): Formula
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6768
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.

Returns
A Formula instance which represents the formula specified.

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: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat): Formula
- Defined in igniteui-angular-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
InvalidEnumArgumentException 'fileFormat' is not defined in the WorkbookFormat enumeration.

Throws
FormulaParseException 'value' is not a valid formula.

Returns
A Formula instance which represents the formula specified.

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: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, culture: string | CultureInfo): Formula
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6793
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.

Returns
A Formula instance which represents the formula specified.

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: string, cellReferenceMode: CellReferenceMode, culture: string | CultureInfo): Formula
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6804
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.

Returns
A Formula instance which represents the formula specified.

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: any, b: any): boolean
Inherited from Base.referenceEquals
- Defined in igniteui-angular-core/lib/type.d.ts:20
Parameters
- a: any
- b: any
Returns boolean

`Static` staticInit

staticInit(): void
- Defined in igniteui-angular-excel/lib/DefaultStyleHelper_combined.d.ts:6490
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

Returns string

Returns

Parameters

cellReferenceMode: CellReferenceMode

Returns string

Returns

Parameters

cellReferenceMode: CellReferenceMode

culture: string | CultureInfo

Returns string

Static areEqual

Returns

Parameters

formulaA: Formula

`Static` $t

`Static` nextHashCode

`Static` areEqual

`Static` compare

`Static` compareSimple

`Static` equalsSimple

`Static` equalsStatic

`Static` getArrayOfProperties

`Static` getArrayOfValues

`Static` getHashCodeStatic

`Static` parse