GetSelections Method (DefaultSheetSelectionModel)

Returns an ordered array of CellRange objects, from largest to smallest, containing the selected cells with minimal overlap between the ranges.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetSelections( _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer _
) As CellRange()

'Usage
 
Dim instance As DefaultSheetSelectionModel
Dim rowCount As Integer
Dim columnCount As Integer
Dim value() As CellRange
 
value = instance.GetSelections(rowCount, columnCount)

public CellRange[] GetSelections( 
   int rowCount,
   int columnCount
)

Parameters

rowCount: Specifies the number of rows in the sheet in which to look
columnCount: Specifies the number of columns in the sheet in which to look

Return Value

Array of CellRange objects containing the ranges of cells

Remarks

The CellRange objects returned by this method are not necessarily the same as the CellRange objects in the model; one or more CellRange objects in the model may be broken up to eliminate redundant overlap between the ranges. Also, the CellRange objects in the returned array are ordered from largest to smallest, rather than in the order in which the ranges were selected, as they are in the model.

Example

This example returns an ordered array of CellRange objects, from largest to smallest, containing the selected cells with minimal overlap between the ranges.

FarPoint.Win.Spread.Model.DefaultSheetSelectionModel ds = new FarPoint.Win.Spread.Model.DefaultSheetSelectionModel();
ds.SelectionPolicy = FarPoint.Win.Spread.Model.SelectionPolicy.MultiRange;
ds.SelectionUnit = FarPoint.Win.Spread.Model.SelectionUnit.Cell;
fpSpread1.ActiveSheet.Models.Selection = ds;
ds.SetSelection(0, 0, 2, 2);
ds.AddSelection(3, 0, 2, 2);
FarPoint.Win.Spread.Model.CellRange[] cr;
cr = ds.GetSelections(10, 5);
MessageBox.Show(cr[0].ColumnCount.ToString());

Visual Basic

Dim ds As New FarPoint.Win.Spread.Model.DefaultSheetSelectionModel
ds.SelectionPolicy = FarPoint.Win.Spread.Model.SelectionPolicy.MultiRange
ds.SelectionUnit = FarPoint.Win.Spread.Model.SelectionUnit.Cell
FpSpread1.ActiveSheet.Models.Selection = ds
ds.SetSelection(0, 0, 2, 2)
ds.AddSelection(3, 0, 2, 2)
Dim cr As FarPoint.Win.Spread.Model.CellRange()
cr = ds.GetSelections(10, 5)
MessageBox.Show(cr(0).ColumnCount.ToString())

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

DefaultSheetSelectionModel Class
DefaultSheetSelectionModel Members