PivotField.SortType Property
Gets or sets the type of sort to apply to the PivotTable field.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v23.2.Core.dll
NuGet Package: DevExpress.Spreadsheet.Core
Declaration
Property Value
| Type | Description |
|---|---|
| PivotFieldSortType | One of the PivotFieldSortType enumeration values specifying the sort order. |
Available values:
| Name | Description |
|---|---|
| Ascending | Sorts the field in ascending order. |
| Descending | Sorts the field in descending order. |
| Manual | Enables manual sorting of field items by dragging them in the UI. Currently, the SpreadsheetControl doesn’t support manual sorting of field items. |
Remarks
Use the SortType property to sort item labels in a specific row, column or page field in a PivotTable report in ascending or descending order. Sort options are available using the PivotField.Sort property.
The following example sorts items of the “Product” field in ascending order.
Worksheet worksheet = workbook.Worksheets["Report1"];
workbook.Worksheets.ActiveWorksheet = worksheet;
// Access the pivot table by its name in the collection.
PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];
// Access the pivot field by its name in the collection.
PivotField field = pivotTable.Fields["Product"];
// Sort items in the "Product" field.
field.SortType = PivotFieldSortType.Ascending;
You can also sort a row or column field based on values in a data field. To do this, use the PivotField.SortItems method.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the SortType 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.