ig.spreadsheet.SpreadsheetSelection
Dependencies
-
activeCell
- .activeCell( );
Returns the cell that represents the active cell.
-
activeCellRangeIndex
- .activeCellRangeIndex( );
Returns the index of the selection group that contains the active cell.
-
addActiveCellRange
- .addActiveCellRange( range:ig.spreadsheet.SpreadsheetCellRange, activeCell:ig.spreadsheet.SpreadsheetCell, [extendRangeForMergedCells:boolean] );
Adds a new cell range for the specified cell and makes it the active cell.
- range
- Type:ig.spreadsheet.SpreadsheetCellRange
- The new range to add
- activeCell
- Type:ig.spreadsheet.SpreadsheetCell
- The new active cell for which a new selection will be added. This must be a cell within range.
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the range such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Exceptions
Exception Description ig.ArgumentException The activeCell must be within the specified range. -
addActiveCellRange
- .addActiveCellRange( rangeAddress:string, activeCellAddress:string, [extendRangeForMergedCells:boolean] );
Adds a new cell range for the specified cell and makes it the active cell.
- rangeAddress
- Type:string
- The new A1 address of the range to add
- activeCellAddress
- Type:string
- The A1 address of the new active cell for which a new selection will be added. This must be a cell within rangeAddress.
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the rangeAddress such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Exceptions
Exception Description ig.ArgumentException The activeCellAddress must be within the specified rangeAddress. -
addCellRange
- .addCellRange( range:ig.spreadsheet.SpreadsheetCellRange, [extendRangeForMergedCells:boolean] );
Adds a new range to the end of the SpreadsheetSelection.cellRanges
- range
- Type:ig.spreadsheet.SpreadsheetCellRange
- The range to be added
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the range such that it contains any intersecting merged cells; otherwise false to use the range as it is.
-
addCellRange
- .addCellRange( rangeAddress:string, [extendRangeForMergedCells:boolean] );
Adds a new range to the end of the SpreadsheetSelection.cellRanges
- rangeAddress
- Type:string
- The A1 address of the range to be added
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the rangeAddress such that it contains any intersecting merged cells; otherwise false to use the range as it is.
-
cellRanges
- .cellRanges( );
Returns a read-only collection of the ranges of cells that are selected.
-
cellRangesAddress
- .cellRangesAddress( );
Returns a string containing the cell ranges in A1 cell reference mode.
Remarks
If there are multiple ranges then they are separated by the default union operator (',').
-
cellRangesAddress
- .cellRangesAddress( value:string );
Sets a string containing the cell ranges in A1 cell reference mode.
- value
- Type:string
Remarks
If there are multiple ranges then they are separated by the default union operator (',').
-
clearCellRanges
- .clearCellRanges( );
Resets the SpreadsheetSelection.cellRanges to a single range containing only the SpreadsheetSelection.activeCell
-
replaceActiveCellRange
- .replaceActiveCellRange( range:ig.spreadsheet.SpreadsheetCellRange, activeCell:ig.spreadsheet.SpreadsheetCell, [extendRangeForMergedCells:boolean] );
- Return Type:
- boolean
- Return Type Description:
- A boolean indicating if the operation was performed.
Replaces the range containing the SpreadsheetSelection.activeCell with the specified range and using the specified cell as the new SpreadsheetSelection.activeCell.
- range
- Type:ig.spreadsheet.SpreadsheetCellRange
- The new range that will replace the range at index SpreadsheetSelection.activeCellRangeIndex.
- activeCell
- Type:ig.spreadsheet.SpreadsheetCell
- The new active cell from within that range.
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the range such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Exceptions
Exception Description ig.ArgumentException The activeCell must be within the specified range. -
replaceActiveCellRange
- .replaceActiveCellRange( rangeAddress:string, activeCellAddress:string, [extendRangeForMergedCells:boolean] );
- Return Type:
- boolean
- Return Type Description:
- A boolean indicating if the operation was performed.
Replaces the range containing the SpreadsheetSelection.activeCell with the specified range and using the specified cell as the new SpreadsheetSelection.activeCell.
- rangeAddress
- Type:string
- The A1 address of the new range that will replace the range at index SpreadsheetSelection.activeCellRangeIndex.
- activeCellAddress
- Type:string
- The A1 address of the new active cell from within that range.
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the rangeAddress such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Exceptions
Exception Description ig.ArgumentException The activeCellAddress must be within the specified rangeAddress. -
resetSelection
- .resetSelection( ranges:ig.spreadsheet.SpreadsheetCellRange[], activeCell:ig.spreadsheet.SpreadsheetCell, newActiveRangeIndex:number, [extendRangeForMergedCells:boolean] );
Clears the current selection and uses the specified information to reinitialize the selection.
- ranges
- Type:ig.spreadsheet.SpreadsheetCellRange[]
- The new selection ranges. There must be 1 or more ranges.
- activeCell
- Type:ig.spreadsheet.SpreadsheetCell
- The cell to use for the SpreadsheetSelection.activeCell. This must be within the specified ranges.
- newActiveRangeIndex
- Type:number
- The index of the range that contains the active cell.
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the ranges such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Exceptions
Exception Description ig.ArgumentNullException The ranges cannot be null. ig.ArgumentException The ranges cannot be a 0 length array. ig.ArgumentException The activeCell must be within the range index specified by the newActiveRangeIndex. ig.ArgumentOutOfRangeException The newActiveRangeIndex must be an index within the specified ranges. -
resetSelection
- .resetSelection( range:ig.spreadsheet.SpreadsheetCellRange, activeCell:ig.spreadsheet.SpreadsheetCell, [extendRangeForMergedCells:boolean] );
Clears the current selection and uses the specified cell as the SpreadsheetSelection.activeCell and specified range as the new selection.
- range
- Type:ig.spreadsheet.SpreadsheetCellRange
- The new selection range
- activeCell
- Type:ig.spreadsheet.SpreadsheetCell
- The cell to use for the SpreadsheetSelection.activeCell. This must be within the specified range.
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the range such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Exceptions
Exception Description ig.ArgumentException The activeCell must be within the specified range. -
resetSelection
- .resetSelection( rangesAddress:string, activeCellAddress:string, newActiveRangeIndex:number, [extendRangeForMergedCells:boolean] );
Clears the current selection and uses the specified information to reinitialize the selection.
- rangesAddress
- Type:string
- The new selection ranges. There must be 1 or more ranges.
- activeCellAddress
- Type:string
- The cell to use for the SpreadsheetSelection.activeCell. This must be within the specified rangesAddress.
- newActiveRangeIndex
- Type:number
- The index of the range that contains the active cell.
- extendRangeForMergedCells
- Type:boolean
- Optional
- True to adjust the rangesAddress such that it contains any intersecting merged cells; otherwise false to use the range as it is.
Exceptions
Exception Description ig.ArgumentException The rangesAddress must contain at least 1 cell/range. ig.ArgumentException The activeCellAddress must be within the range index specified by the newActiveRangeIndex. ig.ArgumentOutOfRangeException The newActiveRangeIndex must be an index within the specified rangesAddress. -
setActiveCell
- .setActiveCell( cell:ig.spreadsheet.SpreadsheetCell, [rangeIndex:number] );
Changes the SpreadsheetSelection.activeCell and SpreadsheetSelection.activeCellRangeIndex to the specified values.
- cell
- Type:ig.spreadsheet.SpreadsheetCell
- The selected cell to change to the active cell
- rangeIndex
- Type:number
- Optional
- Optionally the index of the range in the SpreadsheetSelection.cellRanges that contains the specified cell.
-
setActiveCell
- .setActiveCell( cellAddress:string, [rangeIndex:number] );
Changes the SpreadsheetSelection.activeCell and SpreadsheetSelection.activeCellRangeIndex to the specified values.
- cellAddress
- Type:string
- The A1 address of the selected cell to change to the active cell
- rangeIndex
- Type:number
- Optional
- Optionally the index of the range in the SpreadsheetSelection.cellRanges that contains the specified cell.