Class CellRange

Struct used to refer to a range of cells.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor ColumnCount FirstColumnIndex FirstRowIndex IsEmpty LastColumnIndex LastRowIndex RowCount Empty Contains

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

constructor

  • new CellRange(rowIndex, columnIndex): CellRange

  • Constructor for a single cell.

    Parameters

    • rowIndex: number | Int32

      The index of the row.

    • columnIndex: number | Int32

      The index of the column.

    Returns CellRange

    Since

    2.0

  • new CellRange(firstRowIndex, firstColumnIndex, lastRowIndex, lastColumnIndex): CellRange

  • Initializes a new instance of the Spotfire.Dxp.Application.Visuals.CellRange struct.

    Parameters

    • firstRowIndex: number | Int32

      The index of the first row.

    • firstColumnIndex: number | Int32

      The index of the first column.

    • lastRowIndex: number | Int32

      The index of the last row.

    • lastColumnIndex: number | Int32

      The index of the last column.

    Returns CellRange

    Since

    2.0

ColumnCount

  • get ColumnCount(): number

  • Gets the number of columns in the range.

    Returns number

    Since

    2.0

FirstColumnIndex

  • get FirstColumnIndex(): number

  • Gets the first column index in the range.

    Returns number

    Since

    2.0

FirstRowIndex

  • get FirstRowIndex(): number

  • Gets the first row index in the range.

    Returns number

    Since

    2.0

IsEmpty

  • get IsEmpty(): boolean

  • Gets a value indicating if this is an empty range.

    Returns boolean

    Since

    2.0

LastColumnIndex

  • get LastColumnIndex(): number

  • Gets the last column index in the range.

    Returns number

    Since

    2.0

LastRowIndex

  • get LastRowIndex(): number

  • Gets the last row index in the range.

    Returns number

    Since

    2.0

RowCount

  • get RowCount(): number

  • Gets the number of rows in the range.

    Returns number

    Since

    2.0

StaticEmpty

Contains

  • Contains(rowIndex, columnIndex): boolean

  • Checks if a row index and a column index is within this range.

    Parameters

    • rowIndex: number | Int32

      The row index.

    • columnIndex: number | Int32

      The column index.

    Returns boolean

    true if this range contains the given row and column indexes; otherwise false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability