Back to Devexpress

SortField.Comparer Property

officefileapi-devexpress-dot-spreadsheet-dot-sortfield.md

latest4.7 KB
Original Source

SortField.Comparer Property

Gets or sets the comparer used to sort the column.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
public IComparer<CellValue> Comparer { get; set; }
vb
Public Property Comparer As IComparer(Of CellValue)

Property Value

TypeDescription
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.

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.

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

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

wpf-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/SortActions.cs#L127

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

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

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

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

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

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

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

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

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

See Also

SortField Class

SortField Members

DevExpress.Spreadsheet Namespace