ig.spreadsheet.SpreadsheetCellRange

Represents a range of one or more cells.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_web.js
infragistics.xml.js
infragistics.dv_interactivity.js
infragistics.dv_core.js
infragistics.documents.core_core.js
infragistics.excel_core.js
infragistics.ext_ui.js
infragistics.undo.js
  • empty

    Type:
    ig.spreadsheet.SpreadsheetCellRange
    Default:

    Returns a SheetCellRange instance that represents a null or unspecified/empty range.

The current widget has no events.
  • ig.spreadsheet.SpreadsheetCellRange
    Constructor

    new $.ig.spreadsheet.SpreadsheetCellRange( firstRow:number, firstColumn:number );

    Initializes a new SpreadsheetCellRange

    • firstRow
    • Type:number
    • The index of the first row in the range.
    • firstColumn
    • Type:number
    • The index of the first column in the range
  • ig.spreadsheet.SpreadsheetCellRange
    Constructor

    new $.ig.spreadsheet.SpreadsheetCellRange( firstRow:number, firstColumn:number, lastRow:number, lastColumn:number );

    Initializes a new SpreadsheetCellRange

    • firstRow
    • Type:number
    • The index of the first row in the range.
    • firstColumn
    • Type:number
    • The index of the first column in the range
    • lastRow
    • Type:number
    • The index of the last row in the range
    • lastColumn
    • Type:number
    • The index of the last column in the range
  • ig.spreadsheet.SpreadsheetCellRange
    Constructor

    new $.ig.spreadsheet.SpreadsheetCellRange( address:string );

    Initializes a new SpreadsheetCellRange with the specified A1 style ramge address

    • address
    • Type:string
    • The address of the cell range using the A1 cell reference mode.
  • ig.spreadsheet.SpreadsheetCellRange
    Constructor

    new $.ig.spreadsheet.SpreadsheetCellRange( );

  • contains

    .contains( cell:ig.spreadsheet.SpreadsheetCell );
    Return Type:
    boolean
    Return Type Description:
    Returns true if the cell is within the range; otherwise false.

    Returns a boolean indicating if the specified cell is within the range.

    • cell
    • Type:ig.spreadsheet.SpreadsheetCell
    • The cell to evaluate
  • contains

    .contains( range:ig.spreadsheet.SpreadsheetCellRange );
    Return Type:
    boolean
    Return Type Description:
    Returns true if the range is within this range; otherwise false.

    Returns a boolean indicating if the specified range is completely within this range.

    • range
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • The range to evaluate
  • contains

    .contains( row:number, column:number );
    Return Type:
    boolean
    Return Type Description:
    Returns true if the cell is within the range; otherwise false.

    Returns a boolean indicating if the specified cell is within the range.

    • row
    • Type:number
    • The row to evaluate
    • column
    • Type:number
    • The column to evaluate
  • equals

    .equals( other:ig.spreadsheet.SpreadsheetCellRange );
    Return Type:
    boolean
    Return Type Description:
    True if the specified SheetCellRange has the same SpreadsheetCellRange.firstRow, SpreadsheetCellRange.lastRow, SpreadsheetCellRange.firstColumn and SpreadsheetCellRange.lastColumn; otherwise false.

    Compares the value of this SheetCellRange instance to the specified SpreadsheetCellRange.

  • equals

    .equals( obj:object );
    Return Type:
    boolean
    Return Type Description:
    True if the object is a SheetCellRange with the same SpreadsheetCellRange.firstRow, SpreadsheetCellRange.lastRow, SpreadsheetCellRange.firstColumn and SpreadsheetCellRange.lastColumn.

    Compares the specified SpreadsheetCellRange to this instance's values.

    • obj
    • Type:object
    • The object to compare to the current instance
  • firstColumn

    .firstColumn( );

    Returns the index of the first column in the range.

  • firstRow

    .firstRow( );

    Returns the index of the first row in the range.

  • getHashCode

    .getHashCode( );
    Return Type:
    number
    Return Type Description:
    A hash value for the SheetCellRange

    Returns a hash value for the SpreadsheetCellRange

  • intersect

    .intersect( range:ig.spreadsheet.SpreadsheetCellRange );
    Return Type:
    ig.spreadsheet.SpreadsheetCellRange
    Return Type Description:
    A range that represents the common area between the current and specified range or SpreadsheetCellRange.empty if there is no overlap.

    Returns a range that represents the common area within the current and specified range.

    • range
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • The range to intersect with.
  • intersectsWith

    .intersectsWith( range:ig.spreadsheet.SpreadsheetCellRange );
    Return Type:
    boolean
    Return Type Description:
    Returns true if the ranges have at least 1 row and column in common; otherwise false.

    Returns a boolean indicating if the current and specified range overlap.

    • range
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • The range to compare with.
  • isEmpty

    .isEmpty( );

    Returns a boolean indicating if the structure represents a valid range.

  • isSingleCell

    .isSingleCell( );

    Returns a boolean indicating if the range represents a single cell.

  • l_op_Equality

    .l_op_Equality( d1:ig.spreadsheet.SpreadsheetCellRange, d2:ig.spreadsheet.SpreadsheetCellRange );

    • d1
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • d2
    • Type:ig.spreadsheet.SpreadsheetCellRange
  • l_op_Equality_Lifted

    .l_op_Equality_Lifted( d1:ig.spreadsheet.SpreadsheetCellRange, d2:ig.spreadsheet.SpreadsheetCellRange );

    • d1
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • d2
    • Type:ig.spreadsheet.SpreadsheetCellRange
  • l_op_Inequality

    .l_op_Inequality( d1:ig.spreadsheet.SpreadsheetCellRange, d2:ig.spreadsheet.SpreadsheetCellRange );

    • d1
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • d2
    • Type:ig.spreadsheet.SpreadsheetCellRange
  • l_op_Inequality_Lifted

    .l_op_Inequality_Lifted( d1:ig.spreadsheet.SpreadsheetCellRange, d2:ig.spreadsheet.SpreadsheetCellRange );

    • d1
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • d2
    • Type:ig.spreadsheet.SpreadsheetCellRange
  • lastColumn

    .lastColumn( );

    Returns the index of the last column in the range.

  • lastRow

    .lastRow( );

    Returns the index of the last row in the range.

  • op_Equality

    .op_Equality( d1:ig.spreadsheet.SpreadsheetCellRange, d2:ig.spreadsheet.SpreadsheetCellRange );
    Return Type:
    boolean
    Return Type Description:
    True if the objects have the same SpreadsheetCellRange.firstRow, SpreadsheetCellRange.lastRow, SpreadsheetCellRange.firstColumn and SpreadsheetCellRange.lastColumn; otherwise false.

    Compares two SpreadsheetCellRange instances to determine if they are equal

    • d1
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • The first SheetCellRange instance
    • d2
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • The second SheetCellRange instance
  • op_Inequality

    .op_Inequality( d1:ig.spreadsheet.SpreadsheetCellRange, d2:ig.spreadsheet.SpreadsheetCellRange );
    Return Type:
    boolean
    Return Type Description:
    True if the objects have a different SpreadsheetCellRange.firstRow, SpreadsheetCellRange.lastRow, SpreadsheetCellRange.firstColumn and/or SpreadsheetCellRange.lastColumn; otherwise false.

    Compares two SpreadsheetCellRange instances to determine if they are not equal

    • d1
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • The first SheetCellRange instance
    • d2
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • The second SheetCellRange instance
  • toString

    .toString( );
    Return Type:
    string
    Return Type Description:
    A string representation of the row and column indices.

    Returns a string representation of the SpreadsheetCellRange

  • toString

    .toString( mode:ig.excel.CellReferenceMode );
    Return Type:
    string
    Return Type Description:
    A string containing the upper left cell if this is a single cell otherwise a string containing the upper left and lower right cells.

    Returns a string representation of the range using the specified mode.

    • mode
    • Type:ig.excel.CellReferenceMode
    • An enumeration used to indicate how references are represented
  • union

    .union( range:ig.spreadsheet.SpreadsheetCellRange );
    Return Type:
    ig.spreadsheet.SpreadsheetCellRange
    Return Type Description:
    A range that is large enough to contain the current and specified range.

    Returns a range that contains the contains the current and specified range.

    • range
    • Type:ig.spreadsheet.SpreadsheetCellRange
    • The range to combine with.

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