Class SpreadsheetSelection

An object that represents the selected items within a Spreadsheet

Hierarchy

PropertyChangeNotifierExtended
- SpreadsheetSelection

Constructors

constructor

new SpreadsheetSelection(a: Spreadsheet, b: SpreadsheetPane, c: boolean): SpreadsheetSelection
Overrides PropertyChangeNotifierExtended.constructor
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3642
Parameters
- a: Spreadsheet
- b: SpreadsheetPane
- c: boolean
Returns SpreadsheetSelection

Properties

$type

$type: Type

propertyChanged

propertyChanged: ((sender: any, e: PropertyChangedEventArgs) => void)

Type declaration

- (sender: any, e: PropertyChangedEventArgs): void
- Parameters
  - sender: any
  - e: PropertyChangedEventArgs
  Returns void

`Static` $t

$t: Type

`Static` nextHashCode

nextHashCode: number

Accessors

activeCell

get activeCell(): SpreadsheetCell
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3650
Returns the cell that represents the active cell.

Returns SpreadsheetCell

activeCellRangeIndex

get activeCellRangeIndex(): number
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3658
Returns the index of the selection group that contains the active cell.

Returns number

cellRanges

get cellRanges(): IList$1<SpreadsheetCellRange>
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3662
Returns a read-only collection of the ranges of cells that are selected.

Returns IList$1<SpreadsheetCellRange>

cellRangesAddress

get cellRangesAddress(): string
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3669
Returns or sets a string containing the cell ranges in A1 cell reference mode.

If there are multiple ranges then they are separated by the default union operator (',').

Returns string
set cellRangesAddress(a: string): void
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3670
Parameters
- a: string
Returns void

Methods

addActiveCellRange

addActiveCellRange(range: SpreadsheetCellRange, activeCell: SpreadsheetCell, extendRangeForMergedCells?: boolean): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3754
Adds a new cell range for the specified cell and makes it the active cell.

Throws
ArgumentException The 'activeCell' must be within the specified 'range'.

Parameters
- range: SpreadsheetCellRange
  
  The new range to add
- activeCell: SpreadsheetCell
  
  The new active cell for which a new selection will be added. This must be a cell within 'range'.
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'range' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns boolean
addActiveCellRange(rangeAddress: string, activeCellAddress: string, extendRangeForMergedCells?: boolean): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3762
Adds a new cell range for the specified cell and makes it the active cell.

Throws
ArgumentException The 'activeCellAddress' must be within the specified 'rangeAddress'.

Parameters
- rangeAddress: string
  
  The new A1 address of the range to add
- activeCellAddress: string
  
  The A1 address of the new active cell for which a new selection will be added. This must be a cell within 'rangeAddress'.
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'rangeAddress' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns boolean

addCellRange

addCellRange(range: SpreadsheetCellRange, extendRangeForMergedCells?: boolean): void
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3776
Adds a new range to the end of the cellRanges

Parameters
- range: SpreadsheetCellRange
  
  The range to be added
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'range' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns void
addCellRange(rangeAddress: string, extendRangeForMergedCells?: boolean): void
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3782
Adds a new range to the end of the cellRanges

Parameters
- rangeAddress: string
  
  The A1 address of the range to be added
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'rangeAddress' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns void

addListener

addListener(a: ITypedPropertyChangeListener$2<any, string>, b: boolean): void
Inherited from PropertyChangeNotifierExtended.addListener
- Defined in igniteui-angular-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:14
Parameters
- a: ITypedPropertyChangeListener$2<any, string>
- b: boolean
Returns void

clearCellRanges

clearCellRanges(): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3794
Resets the cellRanges to a single range containing only the activeCell

Returns boolean

d

d(a: any, b: string, c: any): void
Inherited from PropertyChangeNotifierExtended.d
- Defined in igniteui-angular-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:15
Parameters
- a: any
- b: string
- c: any
Returns void

equals

equals(other: any): boolean
Inherited from PropertyChangeNotifierExtended.equals
- Defined in igniteui-angular-core/lib/type.d.ts:10
Parameters
- other: any
Returns boolean

getHashCode

getHashCode(): number
Inherited from PropertyChangeNotifierExtended.getHashCode
- Defined in igniteui-angular-core/lib/type.d.ts:17
Returns number

memberwiseClone

memberwiseClone(): Base
Inherited from PropertyChangeNotifierExtended.memberwiseClone
- Defined in igniteui-angular-core/lib/type.d.ts:19
Returns Base

onPropertyValueChanged

onPropertyValueChanged(a: any, b: string, c: any): void
Inherited from PropertyChangeNotifierExtended.onPropertyValueChanged
- Defined in igniteui-angular-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:18
Parameters
- a: any
- b: string
- c: any
Returns void

removeListener

removeListener(a: ITypedPropertyChangeListener$2<any, string>): void
Inherited from PropertyChangeNotifierExtended.removeListener
- Defined in igniteui-angular-spreadsheet/lib/PropertyChangeNotifierExtended.d.ts:17
Parameters
- a: ITypedPropertyChangeListener$2<any, string>
Returns void

replaceActiveCellRange

replaceActiveCellRange(range: SpreadsheetCellRange, activeCell: SpreadsheetCell, extendRangeForMergedCells?: boolean): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3803
Replaces the range containing the activeCell with the specified range and using the specified cell as the new activeCell.

Returns
A boolean indicating if the operation was performed.

Throws
ArgumentException The 'activeCell' must be within the specified 'range'.

Parameters
- range: SpreadsheetCellRange
  
  The new range that will replace the range at index activeCellRangeIndex.
- activeCell: SpreadsheetCell
  
  The new active cell from within that range.
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'range' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns boolean
replaceActiveCellRange(rangeAddress: string, activeCellAddress: string, extendRangeForMergedCells?: boolean): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3812
Replaces the range containing the activeCell with the specified range and using the specified cell as the new activeCell.

Returns
A boolean indicating if the operation was performed.

Throws
ArgumentException The 'activeCellAddress' must be within the specified 'rangeAddress'.

Parameters
- rangeAddress: string
  
  The A1 address of the new range that will replace the range at index activeCellRangeIndex.
- activeCellAddress: string
  
  The A1 address of the new active cell from within that range.
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'rangeAddress' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns boolean

resetSelection

resetSelection(ranges: SpreadsheetCellRange[], activeCell: SpreadsheetCell, newActiveRangeIndex: number, extendRangeForMergedCells?: boolean): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3832
Clears the current selection and uses the specified information to reinitialize the selection.

Throws
ArgumentNullException The 'ranges' cannot be null.

Throws
ArgumentException The 'ranges' cannot be a 0 length array.

Throws
ArgumentOutOfRangeException The 'newActiveRangeIndex' must be an index within the specified 'ranges'.

Throws
ArgumentException The 'activeCell' must be within the range index specified by the 'newActiveRangeIndex'.

Parameters
- ranges: SpreadsheetCellRange[]
  
  The new selection ranges. There must be 1 or more ranges.
- activeCell: SpreadsheetCell
  
  The cell to use for the activeCell. This must be within the specified 'ranges'.
- newActiveRangeIndex: number
  
  The index of the range that contains the active cell.
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'ranges' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns boolean
resetSelection(range: SpreadsheetCellRange, activeCell: SpreadsheetCell, extendRangeForMergedCells?: boolean): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3840
Clears the current selection and uses the specified cell as the activeCell and specified range as the new selection.

Throws
ArgumentException The 'activeCell' must be within the specified 'range'.

Parameters
- range: SpreadsheetCellRange
  
  The new selection range
- activeCell: SpreadsheetCell
  
  The cell to use for the activeCell. This must be within the specified 'range'.
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'range' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns boolean
resetSelection(rangesAddress: string, activeCellAddress: string, newActiveRangeIndex: number, extendRangeForMergedCells?: boolean): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3851
Clears the current selection and uses the specified information to reinitialize the selection.

Throws
ArgumentException The 'rangesAddress' must contain at least 1 cell/range.

Throws
ArgumentOutOfRangeException The 'newActiveRangeIndex' must be an index within the specified 'rangesAddress'.

Throws
ArgumentException The 'activeCellAddress' must be within the range index specified by the 'newActiveRangeIndex'.

Parameters
- rangesAddress: string
  
  The new selection ranges. There must be 1 or more ranges.
- activeCellAddress: string
  
  The cell to use for the activeCell. This must be within the specified 'rangesAddress'.
- newActiveRangeIndex: number
  
  The index of the range that contains the active cell.
- Optional extendRangeForMergedCells: boolean
  
  True to adjust the 'rangesAddress' such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Returns boolean

setActiveCell

setActiveCell(cell: SpreadsheetCell, rangeIndex?: number): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3869
Changes the activeCell and activeCellRangeIndex to the specified values.

Parameters
- cell: SpreadsheetCell
  
  The selected cell to change to the active cell
- Optional rangeIndex: number
  
  Optionally the index of the range in the cellRanges that contains the specified cell.
Returns boolean
setActiveCell(cellAddress: string, rangeIndex?: number): boolean
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3875
Changes the activeCell and activeCellRangeIndex to the specified values.

Parameters
- cellAddress: string
  
  The A1 address of the selected cell to change to the active cell
- Optional rangeIndex: number
  
  Optionally the index of the range in the cellRanges that contains the specified cell.
Returns boolean

unselectRange

unselectRange(range: SpreadsheetCellRange): void
- Defined in igniteui-angular-spreadsheet/lib/SpreadsheetChartAdapterBase_combined.d.ts:3889
Deselect the cells in the specified range.

Note: if the specified range encompasses all the cells in the selection, the selection will be changed to only include the current activeCell.

Parameters
- range: SpreadsheetCellRange
  
  The range whose cells should be removed from the selection.
Returns void

`Static` compare

compare(item1: any, item2: any): number
Inherited from PropertyChangeNotifierExtended.compare
- Defined in igniteui-angular-core/lib/type.d.ts:14
Parameters
- item1: any
- item2: any
Returns number

`Static` compareSimple

compareSimple(item1: any, item2: any): number
Inherited from PropertyChangeNotifierExtended.compareSimple
- Defined in igniteui-angular-core/lib/type.d.ts:13
Parameters
- item1: any
- item2: any
Returns number

`Static` equalsSimple

equalsSimple(item1: any, item2: any): boolean
Inherited from PropertyChangeNotifierExtended.equalsSimple
- Defined in igniteui-angular-core/lib/type.d.ts:12
Parameters
- item1: any
- item2: any
Returns boolean

`Static` equalsStatic

equalsStatic(a: any, b: any): boolean
Inherited from PropertyChangeNotifierExtended.equalsStatic
- Defined in igniteui-angular-core/lib/type.d.ts:11
Parameters
- a: any
- b: any
Returns boolean

`Static` getArrayOfProperties

getArrayOfProperties(obj: any): any[]
Inherited from PropertyChangeNotifierExtended.getArrayOfProperties
- Defined in igniteui-angular-core/lib/type.d.ts:22
Parameters
- obj: any
Returns any[]

`Static` getArrayOfValues

getArrayOfValues(obj: any): any[]
Inherited from PropertyChangeNotifierExtended.getArrayOfValues
- Defined in igniteui-angular-core/lib/type.d.ts:21
Parameters
- obj: any
Returns any[]

`Static` getHashCodeStatic

getHashCodeStatic(obj: any): number
Inherited from PropertyChangeNotifierExtended.getHashCodeStatic
- Defined in igniteui-angular-core/lib/type.d.ts:18
Parameters
- obj: any
Returns number

`Static` referenceEquals

referenceEquals(a: any, b: any): boolean
Inherited from PropertyChangeNotifierExtended.referenceEquals
- Defined in igniteui-angular-core/lib/type.d.ts:20
Parameters
- a: any
- b: any
Returns boolean

Class SpreadsheetSelection

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

a: Spreadsheet

b: SpreadsheetPane

c: boolean

Returns SpreadsheetSelection

Properties

$type

propertyChanged

Type declaration

Parameters

sender: any

e: PropertyChangedEventArgs

Returns void

Static $t

Static nextHashCode

Accessors

activeCell

Returns SpreadsheetCell

activeCellRangeIndex

Returns number

cellRanges

Returns IList$1<SpreadsheetCellRange>

cellRangesAddress

Returns string

Parameters

a: string

Returns void

Methods

addActiveCellRange

Throws

Parameters

range: SpreadsheetCellRange

activeCell: SpreadsheetCell

Optional extendRangeForMergedCells: boolean

Returns boolean

Throws

Parameters

rangeAddress: string

activeCellAddress: string

Optional extendRangeForMergedCells: boolean

Returns boolean

addCellRange

Parameters

range: SpreadsheetCellRange

Optional extendRangeForMergedCells: boolean

Returns void

Parameters

rangeAddress: string

Optional extendRangeForMergedCells: boolean

Returns void

addListener

Parameters

a: ITypedPropertyChangeListener$2<any, string>

b: boolean

Returns void

clearCellRanges

Returns boolean

d

Parameters

a: any

b: string

c: any

Returns void

equals

Parameters

other: any

Returns boolean

getHashCode

Returns number

memberwiseClone

Returns Base

`Static` $t

`Static` nextHashCode

`Static` compare