Worksheet.Sort(CellRange, Int32, Fill, Boolean) Method

Sorts the specified range by the fill color in a specific order. Allows you to specify column offset.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

void Sort(
    CellRange range,
    int columnOffset,
    Fill fill,
    bool ascending
)

VB.NET

Sub Sort(
    range As CellRange,
    columnOffset As Integer,
    fill As Fill,
    ascending As Boolean
)

Parameters

Name	Type	Description
range	CellRange	The cell range to sort.
columnOffset	Int32	The offset of the column by which to sort, as measured from the first column in the range. The first column has an offset of 0.
fill	Fill	The object that contains fill parameters.
ascending	Boolean	true to specify ascending order; otherwise, false.

Remarks

Example

The following code sample sorts the cell range by background color in column E in descending order:

C#

using DevExpress.Spreadsheet;
using System.Diagnostics;

using (var workbook = new Workbook()) {
    workbook.LoadDocument(@"Document.xlsx");
    Worksheet worksheet = workbook.Worksheets["SortSample"];
    workbook.Worksheets.ActiveWorksheet = worksheet;

    CellRange range = worksheet.Range["A3:F22"];
    Fill fillSettings = worksheet["F15"].Fill;
    worksheet.Sort(range, 5, fillSettings, false);
    workbook.SaveDocument("result.xlsx", DocumentFormat.Xlsx);
    Process.Start(new ProcessStartInfo("result.xlsx") { UseShellExecute = true });
}

VB.NET

Imports DevExpress.Spreadsheet
Imports System.Diagnostics

Using workbook = New Workbook()
  workbook.LoadDocument("Document.xlsx")
  Dim worksheet As Worksheet = workbook.Worksheets("SortSample")
  workbook.Worksheets.ActiveWorksheet = worksheet

  Dim range As CellRange = worksheet.Range("A3:F22")
  Dim fillSettings As Fill = worksheet("F15").Fill
  worksheet.Sort(range, 5, fillSettings, False)
  workbook.SaveDocument("result.xlsx", DocumentFormat.Xlsx)
  Process.Start(New ProcessStartInfo("result.xlsx") With {.UseShellExecute = True})
End Using