ig.excel.ArrayFormula

Represents an array formula for a group of cells.

Remarks

Array formulas are similar to regular formula in that they have the same grammar. However, array formulas must be set on a single region of cells only. When the array formula is applied to a region of cells, each cell's Formula property will be the array formula. The Value of each cell cannot be changed unless ArrayFormula.clearCellRange is called on the array formula or another value is applied to a region of cells which completely contains the array formula's region.

Because the array formula stores the region of the cells to which it is applied in the ArrayFormula.cellRange property, the array formula can only be applied to one region of cells.

Array formulas are created through Microsoft Excel by selecting a region of cells, entering a formula for that range, and pressing Ctrl+Shift+Enter. This causes the formula of each cell in the region to appear as follows: {=Formula}.

See the Microsoft Excel documentation for more information on array formulas.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.

  • cellRange

    .cellRange( );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    The cells to which the array formula is applied.

    Gets the cells to which the array formula is applied.

    Remarks

    If this is null, the formula has not yet been applied.

  • clearCellRange

    .clearCellRange( );

    Removes this array formula as the formula for the cells to which it was applied.

    Remarks

    After this method returns, the ArrayFormula.cellRange will be null.

  • parse

    .parse( value:string, cellReferenceMode:ig.excel.CellReferenceMode );
    Return Type:
    ig.excel.ArrayFormula
    Return Type Description:
    An ArrayFormula instance which represents the array formula value specified.

    Parses the specified formula value and returns the array formula which was created from it.

    • value
    • Type:string
    • The string which defines the array formula to parse.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The mode used to interpret cell references in the array formula.

    Exceptions

    Exception Description
    ig.ArgumentNullException value is null or empty.
    ig.excel.InvalidEnumArgumentException cellReferenceMode is not defined in the CellReferenceMode enumeration.
    ig.excel.FormulaParseException value is not a valid formula.

  • parse

    .parse( value:string, cellReferenceMode:ig.excel.CellReferenceMode, fileFormat:ig.excel.WorkbookFormat );
    Return Type:
    ig.excel.ArrayFormula
    Return Type Description:
    An ArrayFormula instance which represents the array formula value specified.

    Parses the specified formula value and returns the array formula which was created from it.

    • value
    • Type:string
    • The string which defines the array formula to parse.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The mode used to interpret cell references in the array formula.
    • fileFormat
    • Type:ig.excel.WorkbookFormat
    • The file format to use when parsing the array formula. This will be used to determine certain limits which are format dependant.

    Exceptions

    Exception Description
    ig.ArgumentNullException value is null or empty.
    ig.excel.InvalidEnumArgumentException cellReferenceMode is not defined in the CellReferenceMode enumeration.
    ig.excel.InvalidEnumArgumentException fileFormat is not defined in the WorkbookFormat enumeration.
    ig.excel.FormulaParseException value is not a valid formula.

  • parse

    .parse( value:string, cellReferenceMode:ig.excel.CellReferenceMode, fileFormat:ig.excel.WorkbookFormat, culture:string );
    Return Type:
    ig.excel.ArrayFormula
    Return Type Description:
    An ArrayFormula instance which represents the array formula value specified.

    Parses the specified formula value and returns the array formula which was created from it.

    • value
    • Type:string
    • The string which defines the array formula to parse.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The mode used to interpret cell references in the array formula.
    • fileFormat
    • Type:ig.excel.WorkbookFormat
    • The file format to use when parsing the array formula. This will be used to determine certain limits which are format dependant.
    • culture
    • Type:string
    • The culture used to parse the formula.

    Exceptions

    Exception Description
    ig.ArgumentNullException value is null or empty.
    ig.excel.InvalidEnumArgumentException cellReferenceMode is not defined in the CellReferenceMode enumeration.
    ig.excel.InvalidEnumArgumentException fileFormat is not defined in the WorkbookFormat enumeration.
    ig.excel.FormulaParseException value is not a valid formula.

  • parse

    .parse( value:string, cellReferenceMode:ig.excel.CellReferenceMode, culture:string );
    Return Type:
    ig.excel.ArrayFormula
    Return Type Description:
    An ArrayFormula instance which represents the array formula value specified.

    Parses the specified formula value and returns the array formula which was created from it.

    • value
    • Type:string
    • The string which defines the array formula to parse.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The mode used to interpret cell references in the array formula.
    • culture
    • Type:string
    • The culture used to parse the formula.

    Exceptions

    Exception Description
    ig.ArgumentNullException value is null or empty.
    ig.excel.InvalidEnumArgumentException cellReferenceMode is not defined in the CellReferenceMode enumeration.
    ig.excel.FormulaParseException value is not a valid formula.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.