SortField.Comparer Property

Gets or sets the comparer used to sort the column.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public IComparer<CellValue> Comparer { get; set; }

VB.NET

Public Property Comparer As IComparer(Of CellValue)

Property Value

Type	Description
IComparer<CellValue>	A IComparer<T><CellValue,> object used to compare cell values in a column.

Remarks

You can use default built-in comparers - the Worksheet.Comparers.Ascending for sorting in ascending order and the Worksheet.Comparers.Descending for sorting in descending order, or implement a custom comparer.

For an example of a custom comparer, see the Worksheet.Sort method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Comparer property.

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#L84

sortField1.ColumnOffset = 0;
sortField1.Comparer = worksheet.Comparers.Ascending;
fields.Add(sortField1);

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

sortField1.ColumnOffset = 0;
sortField1.Comparer = worksheet.Comparers.Ascending;
fields.Add(sortField1);

VB.NET

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/SortActions.vb#L121

sortField1.ColumnOffset = 0
sortField1.Comparer = worksheet.Comparers.Ascending
fields.Add(sortField1)

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeExamples/SortActions.vb#L70

sortField1.ColumnOffset = 0
sortField1.Comparer = worksheet.Comparers.Ascending
fields.Add(sortField1)

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/SortActions.vb#L120

sortField1.ColumnOffset = 0
sortField1.Comparer = worksheet.Comparers.Ascending
fields.Add(sortField1)