Sort Method (SheetView)

Visual Basic
C#

'Declaration
 
Public Function Sort( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal rowCount As Integer, _
   ByVal columnCount As Integer, _
   ByVal byRows As Boolean, _
   ByVal sortInfo() As SortInfo _
) As Boolean

'Usage
 
Dim instance As SheetView
Dim row As Integer
Dim column As Integer
Dim rowCount As Integer
Dim columnCount As Integer
Dim byRows As Boolean
Dim sortInfo() As SortInfo
Dim value As Boolean
 
value = instance.Sort(row, column, rowCount, columnCount, byRows, sortInfo)

public bool Sort( 
   int row,
   int column,
   int rowCount,
   int columnCount,
   bool byRows,
   SortInfo[] sortInfo
)

Parameters

row: Starting sheet row index
column: Starting sheet column index
rowCount: Number of rows in the sheet to sort
columnCount: Number of columns in the sheet to sort
byRows: Whether the sort should move rows in the range (true) or columns in the range (false)
sortInfo: Array of SortInfo objects containing the column indexes (if byRows is true) or row indexes (if byRows is false) and the order of sorting

Return Value

true if successful; otherwise false

This example illustrates the use of this member by setting the range of cells for the sort.

C#

FarPoint.Web.Spread.SheetView sv;
FarPoint.Web.Spread.SortInfo[] s = new FarPoint.Web.Spread.SortInfo[1];
s[0] = new FarPoint.Web.Spread.SortInfo(0, false);
sv = FpSpread1.ActiveSheetView;
sv.Sort(0, 0, 3, 1, true, s);

Visual Basic

Dim sv As FarPoint.Web.Spread.SheetView
Dim s(1) As FarPoint.Web.Spread.SortInfo
s(0) = New FarPoint.Web.Spread.SortInfo(0, False)
sv = FpSpread1.ActiveSheetView
sv.Sort(0, 0, 3, 1, True, s)

Reference

SheetView Class
SheetView Members
SetSortIndicator Method
SortIndicator Enumeration
SortColumns Method
SortRows Method

User-Task Documentation

Customizing Sorting of Rows of User Data