PivotGridField.SortByField Property

Gets or sets the field whose summary values define the order in which the field’s values are arranged. This is a dependency property.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v24.1.dll

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public PivotGridField SortByField { get; set; }

VB.NET

Public Property SortByField As PivotGridField

Property Value

Type	Description
PivotGridField	A PivotGridField object that represents the field whose summary values define the order in which the field’s values are arranged. Note that this field should be placed in Data Header Area.

Remarks

To sort data by summaries, do the following:

• Use the PivotGridField.SortByField or PivotGridField.SortByFieldName property to specify a field (typically a data field) against which summary values should be calculated. If the PivotGridField.SortByField property is used, the summary type is specified by this field’s PivotGridField.SummaryType property. If the PivotGridField.SortByFieldName property is used, the required summary type should be specified using the PivotGridField.SortBySummaryType property.
• To sort data according to an individual column or row, you need to specify the column or row via the PivotGridField.SortByConditions collection. Do this by adding items to this collection, each of which identifies a specific field and its value.

To learn more, see Sorting by Summary.

Example

This example shows how to sort data by Grand Total values.

In this example, values of the Sales Person field are sorted by the Grand Total column. To do this, the data field by whose values the sorting should be performed (the Order Amount field) is assigned to the Sales Person field’s PivotGridField.SortByField property.

MainWindow.xaml

<Window x:Class="HowToBindToMDB.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid"
        Title="MainWindow" Height="350" Width="525" Loaded="Window_Loaded">
    <Grid>
        <dxpg:PivotGridControl HorizontalAlignment="Left" Name="pivotGridControl1" 
                               VerticalAlignment="Top">
            <dxpg:PivotGridControl.Fields>
                <dxpg:PivotGridField Name="fieldMonth" FieldName="OrderDate" Area="RowArea"
                                     Caption="Order Month" GroupInterval="DateMonth" />
                <dxpg:PivotGridField Name="fieldSalesPerson" FieldName="Sales Person" Area="RowArea"
                                     SortByField="{Binding ElementName=fieldOrderAmount}"
                                     Caption="Sales Person" SortOrder="Descending"/>                
                <dxpg:PivotGridField Name="fieldOrderAmount" FieldName="Extended Price" Area="DataArea"
                                     Caption="Order Amount" CellFormat="c0" />
            </dxpg:PivotGridControl.Fields>
        </dxpg:PivotGridControl>
    </Grid>
</Window>

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SortByField 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#

wpf-pivot-grid-show-top-n-values-in-context-menu/CS/ContextMenuToShowTopN_Example/MainWindow.xaml.cs#L81

f.SortOrder = FieldSortOrder.Descending;
f.SortByField = valueItem.DataField;
f.SortByConditions.Clear();

VB.NET

wpf-pivot-grid-show-top-n-values-in-context-menu/VB/ContextMenuToShowTopN_Example/MainWindow.xaml.vb#L78

f.SortOrder = FieldSortOrder.Descending
f.SortByField = valueItem.DataField
f.SortByConditions.Clear()