Worksheet.Sort(CellRange, Int32, Fill) Method

Sorts the specified range by the fill color. 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
)

VB.NET

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

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	An object that contains fill parameters.

Remarks

Example:

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

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);
    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("C: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)
  workbook.SaveDocument("result.xlsx", DocumentFormat.Xlsx)
  Process.Start(New ProcessStartInfo("result.xlsx") With {.UseShellExecute = True})

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Sort(CellRange, Int32, Fill) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeExamples/SortActions.cs#L109

CellRange range = worksheet.Range["A3:F22"];
worksheet.Sort(range, 0, worksheet["A3"].Fill);

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/SortActions.cs#L146

CellRange range = worksheet.Range["A3:F22"];
worksheet.Sort(range, 0, worksheet["A3"].Fill);