PivotGridFieldBase.SortOrder Property

Gets or sets the field’s sort order.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v20.2.Core.dll

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.WindowsDesktop.PivotGrid.Core

Declaration

C#

[DefaultValue(PivotSortOrder.Ascending)]
public PivotSortOrder SortOrder { get; set; }

VB.NET

<DefaultValue(PivotSortOrder.Ascending)>
Public Property SortOrder As PivotSortOrder

Property Value

Type	Default	Description
PivotSortOrder	**Ascending**	A PivotSortOrder value that specifies the field’s sort order.

Available values:

Name	Description
Ascending	Sorts the field in ascending order.
Descending	Sorts the field in descending order.

Remarks

Data within the PivotGridControl is always sorted against the fields displayed within Column Header Area and Row Header Area (by default, in ascending order). Use the SortOrder property of these fields to change the current sort order. For other fields, changing the SortOrder property value has no effect on data representation until these fields are placed within the Column Header Area or Row Header Area.

You can also use the PivotGridFieldBase.ChangeSortOrder (synchronous) and PivotGridControl.ChangeFieldSortOrderAsync (asynchronous) methods to toggle a field sort order.

To respond to a field’s sort order being changed, handle the PivotGridControl.GridLayout event.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SortOrder 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#

sort-a-xtrapivotgrid-by-clicking-on-a-field-value-and-toggle-sort-order-e2705/CS/Form1.cs#L45

if(!sortOrder.HasValue || sortOrder.Value == PivotSortOrder.Descending)
    otherFields[i].SortOrder = PivotSortOrder.Ascending;
else

using-customfilterpopupitems-event-to-apply-custom-sort-order-to-filter-popup-items-e3247/CS/WindowsApplication1/Form1.cs#L73

    return;
if(rowField.SortOrder == PivotSortOrder.Ascending)
    return;

VB.NET

using-customfilterpopupitems-event-to-apply-custom-sort-order-to-filter-popup-items-e3247/VB/WindowsApplication1/Form1.vb#L78

End If
If rowField.SortOrder = PivotSortOrder.Ascending Then
    Return