Spread WPF Documentation - SortRange Method

SortRange Method

In This Topic

Sorts a range of cells in this sheet in the data model.

Syntax

Visual Basic
C#

'Declaration
 
Public Function SortRange( _
   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 Worksheet
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.SortRange(row, column, rowCount, columnCount, byRows, sortInfo)

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

Parameters

row: The index of the starting row of the block of cells to sort.
column: The index of the starting column of the block of cells to sort.
rowCount: The number of rows in the block of cells.
columnCount: The number of columns in the block of cells.
byRows: Set to true to sort by rows; false to sort by columns.
sortInfo: The SortInfo object with sort criteria and information about how to perform the sort.

Return Value

true if the data is successfully sorted; otherwise, false.

Example

This example uses the SortRange method.

for (int i = 0; i < 10; i++)
            {
                gcSpreadSheet1.Sheets[0].SetValue(i, 0, i);
            }

 private void Button_Click(object sender, RoutedEventArgs e)
        {
            gcSpreadSheet1.Sheets[0].SortRange(0, 0, 10, 1, true, new SortInfo[] { new SortInfo(0, false) });
            gcSpreadSheet1.Invalidate();
        }

VB.NET

For i As Integer = 0 To 9
            GcSpreadSheet1.Sheets(0).SetValue(i, 0, i)
        Next

Private Sub Button_Click(sender As System.Object, e As System.Windows.RoutedEventArgs)
        GcSpreadSheet1.Sheets(0).SortRange(0, 0, 10, 1, True, New SortInfo() {New SortInfo(0, False)})
        GcSpreadSheet1.Invalidate()
    End Sub

Reference

Worksheet Class
Worksheet Members

Product Support Forum | Print this page