Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

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

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

constructor

  • new Formula(a, b, c): Formula

  • Parameters

    • a: number
    • b: number
    • c: FormulaType

    Returns Formula

  • new Formula(a, b): Formula

  • Parameters

    Returns Formula

  • new Formula(a, b): Formula

  • Parameters

    Returns Formula

  • new Formula(a, b, c?): Formula

  • Parameters

    • a: number
    • b: Formula
    • Optional c: boolean

    Returns Formula

  • new Formula(a, ..._rest): Formula

  • 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

  • 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

    Returns void

  • applyTo(cell): void

  • 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

    Returns void

  • applyTo(region): void

  • 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

    Returns void

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

toString

  • toString(): string

  • 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

  • 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

  • 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

  • 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

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static parse

  • parse(value, cellReferenceMode): Formula

  • 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

  • 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

  • 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

  • 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

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • staticInit(): void

  • Returns void