ig.excel.WorksheetReferenceCollection

A collection of cells or regions which are all on the same WorksheetReferenceCollection.worksheet.

Dependencies

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

  • ig.excel.WorksheetReferenceCollection
    Constructor

    new $.ig.excel.WorksheetReferenceCollection( worksheet:ig.excel.Worksheet );

    Creates a new WorksheetReferenceCollection instance.

    • worksheet
    • Type:ig.excel.Worksheet
    • The worksheet to which the references in the collection will belong.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when worksheet is null.

  • ig.excel.WorksheetReferenceCollection
    Constructor

    new $.ig.excel.WorksheetReferenceCollection( worksheet:ig.excel.Worksheet, references:string );

    Creates a new WorksheetReferenceCollection instance.

    • worksheet
    • Type:ig.excel.Worksheet
    • The worksheet to which the references in the collection will belong.
    • references
    • Type:string
    • The space delimited list of references to add to the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when worksheet is null.
    ig.ArgumentNullException Occurs when the references is null.
    ig.ArgumentException Occurs when the list of reference is not well formed.

  • ig.excel.WorksheetReferenceCollection
    Constructor

    new $.ig.excel.WorksheetReferenceCollection( cell:ig.excel.WorksheetCell );

    Creates a new WorksheetReferenceCollection instance and initializes it with a cell.

    • cell
    • Type:ig.excel.WorksheetCell
    • The cell with which the collection should be initialized.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when cell is null.

  • ig.excel.WorksheetReferenceCollection
    Constructor

    new $.ig.excel.WorksheetReferenceCollection( region:ig.excel.WorksheetRegion );

    Creates a new WorksheetReferenceCollection instance and initializes it with a cell.

    • region
    • Type:ig.excel.WorksheetRegion
    • The cell with which the collection should be initialized.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when region is null.

  • add

    .add( region:ig.excel.WorksheetRegion );

    Adds a region to the collection of references.

    • region
    • Type:ig.excel.WorksheetRegion
    • The region to add to the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the region is null.
    ig.ArgumentException Occurs when the region is from a Worksheet other than the references collection.

    Remarks

    The region added to the collection must be from the same WorksheetReferenceCollection.worksheet as the collection.

    If the region is already contained in the collection, or there is a region in the collection which fully contains the specified region, this call will have no effect on the collection.

  • add

    .add( cell:ig.excel.WorksheetCell );

    Adds a cell to the collection of references.

    • cell
    • Type:ig.excel.WorksheetCell
    • The cell to add to the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the cell is null.
    ig.ArgumentException Occurs when the cell is from a Worksheet other than the references collection.

    Remarks

    The cell added to the collection must be from the same WorksheetReferenceCollection.worksheet as the collection.

    If the cell is already contained in the collection, or there is a region in the collection which contains the cell, this call will have no effect on the collection.

  • add

    .add( references:string );

    Adds a list of references to the collection of references.

    • references
    • Type:string
    • The space delimited list of references to add to the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the references is null.
    ig.ArgumentException Occurs when the list of reference is not well formed.

    Remarks

    The references must be separated by one or more space (' ') characters.

    The references in the list cannot contain the worksheet name. They are all assumed to be from the worksheet of this collection.

    If all references are already contained in the collection this call will have no effect on the collection.

  • add

    .add( references:string, cellReferenceMode:ig.excel.CellReferenceMode );

    Adds a list of references to the collection of references.

    • references
    • Type:string
    • The space delimited list of references to add to the collection.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The cell reference mode with which to parse the references.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the references is null.
    ig.excel.InvalidEnumArgumentException Occurs when cellReferenceMode is not defined in the CellReferenceMode enumeration.
    ig.ArgumentException Occurs when the list of reference is not well formed.

    Remarks

    The references must be separated by one or more space (' ') characters.

    The references in the list cannot contain the worksheet name. They are all assumed to be from the worksheet of this collection.

    If all references are already contained in the collection this call will have no effect on the collection.

  • cellsCount

    .cellsCount( );

    Gets the number of cells contains in all references in this collection.

  • clear

    .clear( );

    Clears all references from the collection.

  • contains

    .contains( region:ig.excel.WorksheetRegion );
    Return Type:
    boolean
    Return Type Description:
    True if the region is contained in the collection or a region which fully contains the specified region is contained in the collection; False otherwise.

    Determines whether the collection contains the specified region.

    • region
    • Type:ig.excel.WorksheetRegion
    • The region to search for in the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the region is null.

  • contains

    .contains( cell:ig.excel.WorksheetCell );
    Return Type:
    boolean
    Return Type Description:
    True if the cell is contained in the collection or a region which contains the cell is contained in the collection; False otherwise.

    Determines whether the collection contains the specified cell.

    • cell
    • Type:ig.excel.WorksheetCell
    • The cell to search for in the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the cell is null.

  • remove

    .remove( region:ig.excel.WorksheetRegion );
    Return Type:
    boolean
    Return Type Description:
    True if any cells in the region were found and removed. False otherwise.

    Removes a region from the collection of references.

    • region
    • Type:ig.excel.WorksheetRegion
    • The region to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the region is null.

    Remarks

    If the region is not contained in the collection, this call will have no effect on the collection.

  • remove

    .remove( cell:ig.excel.WorksheetCell );
    Return Type:
    boolean
    Return Type Description:
    True if the cell was found and removed. False otherwise.

    Removes a cell from the collection of references.

    • cell
    • Type:ig.excel.WorksheetCell
    • The cell to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the cell is null.

    Remarks

    If the cell is not contained in the collection, this call will have no effect on the collection.

  • remove

    .remove( references:string );
    Return Type:
    boolean
    Return Type Description:
    True if any cells in the references were found and removed. False otherwise.

    Removes a list of references from the collection of references.

    • references
    • Type:string
    • The space delimited list of references to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the references is null.
    ig.ArgumentException Occurs when the list of reference is not well formed.

    Remarks

    The references must be separated by one or more space (' ') characters.

    The references in the list cannot contain the worksheet name. They are all assumed to be from the worksheet of this collection.

    If the references are not contained in the collection, this call will have no effect on the collection.

  • remove

    .remove( references:string, cellReferenceMode:ig.excel.CellReferenceMode );
    Return Type:
    boolean
    Return Type Description:
    True if any cells in the references were found and removed. False otherwise.

    Removes a list of references from the collection of references.

    • references
    • Type:string
    • The space delimited list of references to remove from the collection.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The cell reference mode with which to parse the references.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when the references is null.
    ig.excel.InvalidEnumArgumentException Occurs when cellReferenceMode is not defined in the CellReferenceMode enumeration.
    ig.ArgumentException Occurs when the list of reference is not well formed.

    Remarks

    The references must be separated by one or more space (' ') characters.

    The references in the list cannot contain the worksheet name. They are all assumed to be from the worksheet of this collection.

    If the references are not contained in the collection, this call will have no effect on the collection.

  • toString

    .toString( );

    Returns the string value represent the cell and region addresses in the collection.

  • toString

    .toString( cellReferenceMode:ig.excel.CellReferenceMode );

    Returns the string value represent the cell and region addresses in the collection.

    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • The cell reference mode with which to get the region strings.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException Occurs when cellReferenceMode is not defined in the CellReferenceMode enumeration.

  • worksheet

    .worksheet( );

    Gets the worksheet for which this collection contains references.

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