SortRows(Int32,Boolean,Boolean,IComparer) Method

Sorts all the rows on this sheet by the specified column using the specified comparison.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SortRows( _
   ByVal keyColumn As Integer, _
   ByVal ascending As Boolean, _
   ByVal showIndicator As Boolean, _
   ByVal comparer As IComparer _
) As Boolean

'Usage
 
Dim instance As SheetView
Dim keyColumn As Integer
Dim ascending As Boolean
Dim showIndicator As Boolean
Dim comparer As IComparer
Dim value As Boolean
 
value = instance.SortRows(keyColumn, ascending, showIndicator, comparer)

public bool SortRows( 
   int keyColumn,
   bool ascending,
   bool showIndicator,
   IComparer comparer
)

Parameters

keyColumn: Column index whose values are compared during sorting
ascending: Whether to sort in ascending order
showIndicator: Whether the sort indicator should be displayed
comparer: IComparer object used to compare the values

Return Value

Boolean: true if successful; false otherwise

Remarks

Use this method to sort all the rows in the sheet. It sorts the arrangement of rows in a sheet using one or more columns as the key. It is similar to the simpler SortRows(Int32,Boolean,Boolean) method, but adds an option for specifying the way of comparing that is used. Use this method to do a sort beyond the comparison technique provided by the comparer in the .NET framework.

This does not affect the data model, only how the data is displayed. Different overloads provide different ways to sort the rows.

Example

This example sorts a range of rows.

fpSpread1.ActiveSheet.SetValue(0, 0, "S");
fpSpread1.ActiveSheet.SetValue(0, 1, "E");
fpSpread1.ActiveSheet.SetValue(0, 2, "A");
fpSpread1.ActiveSheet.SetValue(0, 3, "K");
fpSpread1.ActiveSheet.SetValue(1, 0, "W");
fpSpread1.ActiveSheet.SetValue(1, 1, "G");
fpSpread1.ActiveSheet.SetValue(1, 2, "P");
fpSpread1.ActiveSheet.SetValue(1, 3, "V");
fpSpread1.ActiveSheet.SetValue(2, 0, "O");
fpSpread1.ActiveSheet.SetValue(2, 1, "L");
fpSpread1.ActiveSheet.SetValue(2, 2, "Q");
fpSpread1.ActiveSheet.SetValue(2, 3, "H");
fpSpread1.ActiveSheet.SortRows(1, false, true, System.Collections.Comparer.Default);

Visual Basic

FpSpread1.ActiveSheet.SetValue(0, 0, "S")
FpSpread1.ActiveSheet.SetValue(0, 1, "E")
FpSpread1.ActiveSheet.SetValue(0, 2, "A")
FpSpread1.ActiveSheet.SetValue(0, 3, "K")
FpSpread1.ActiveSheet.SetValue(1, 0, "W")
FpSpread1.ActiveSheet.SetValue(1, 1, "G")
FpSpread1.ActiveSheet.SetValue(1, 2, "P")
FpSpread1.ActiveSheet.SetValue(1, 3, "V")
FpSpread1.ActiveSheet.SetValue(2, 0, "O")
FpSpread1.ActiveSheet.SetValue(2, 1, "L")
FpSpread1.ActiveSheet.SetValue(2, 2, "Q")
FpSpread1.ActiveSheet.SetValue(2, 3, "H")
FpSpread1.ActiveSheet.SortRows(1, False, True, System.Collections.Comparer.Default)

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

SheetView Class
SheetView Members
Overload List