SortByCondition Class

Represents a sort condition used to identify the column/row by whose values the other field values will be sorted.

Assembly: DevExpress.Xpf.PivotGrid.v19.2.dll

Declaration

C#
VB.NET

public class SortByCondition :
    DXFrameworkContentElement

Public Class SortByCondition
    Inherits DXFrameworkContentElement

Remarks

To identify the column/row by whose values their values will be sorted, pivot grid fields hold the PivotGridField.SortByConditions collection, which contains the SortByCondition objects.

A sort condition represents a field value. The PivotGridField.SortByConditions collection contains one sort condition for each field in the current Header Area. Together, these conditions identify the required column/row. For instance, the highlighted column on the image below is identified by three sort conditions.

pivotgrid_SortByCondition

The field value which the sort condition represents is specified by the SortByCondition.Value property. The field to which the value belongs is specified by the SortByCondition.Field property.

If the pivot grid is bound to an OLAP data source, the field value is identified by the corresponding OLAP member’s unique name (SortByCondition.OlapUniqueMemberName). In this instance, the SortByCondition.Value property is set to null.

Example

The following example demonstrates how to sort data by a particular column.

In this example, values of the Product Name field are sorted by September 1994 column summary values. To do this, two sort conditions represented by SortByCondition instances are created. One of them identifies the ‘1994’ field value, while another identifies the ‘September’ value. These sort conditions are added to the Product Name field’s PivotGridField.SortByConditions collection to specify the column by which Product Name values should be sorted. A data field that identifies the column is specified via the PivotGridField.SortByField property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-sort-data-by-a-particular-column-or-row-e3090.

using System.Windows;
using DevExpress.Xpf.PivotGrid;

namespace DXPivotGrid_SortBySummary {
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            pivotGridControl1.DataSource = 
                (new nwindDataSetTableAdapters.SalesPersonTableAdapter()).GetData();
        }
        private void pivotGridControl1_Loaded(object sender, RoutedEventArgs e) {

            // Locks the pivot grid from updating while the Sort by Summary
            // settings are being customized.
            pivotGridControl1.BeginUpdate();
            try {

                // Specifies a data field whose summary values should be used to sort values
                // of the Product Name field.
                fieldProductName.SortByField = fieldUnitPrice;

                // Specifies a column by which the Product Name field values should be sorted.
                fieldProductName.SortByConditions.Add(new SortByCondition(fieldYear, "1994"));
                fieldProductName.SortByConditions.Add(new SortByCondition(fieldMonth, "9"));
            }
            finally {

                // Unlocks the pivot grid and applies changes.
                pivotGridControl1.EndUpdate();
            }
        }
    }
}

<Window xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        x:Class="DXPivotGrid_SortBySummary.MainWindow"
        Height="600" Width="800" Title="Main Window">
    <Grid>
        <dxpg:PivotGridControl Name="pivotGridControl1" Loaded="pivotGridControl1_Loaded">
            <dxpg:PivotGridControl.Fields>
                <dxpg:PivotGridField Name="fieldUnitPrice" FieldName="UnitPrice" Area="DataArea"/>
                <dxpg:PivotGridField Name="fieldYear" FieldName="OrderDate" Area="ColumnArea"
                                     Caption="Year" GroupInterval="DateYear"/>
                <dxpg:PivotGridField Name="fieldMonth" FieldName="OrderDate" Area="ColumnArea"
                                     Caption="Month" GroupInterval="DateMonth"/>
                <dxpg:PivotGridField Name="fieldCategoryName" FieldName="CategoryName"
                                     Area="RowArea" Caption="Category"/>
                <dxpg:PivotGridField Name="fieldProductName" FieldName="ProductName"
                                     Area="RowArea" Caption="Product"/>
                <dxpg:PivotGridField Name="fieldQuantity" FieldName="Quantity" Area="DataArea"/>
            </dxpg:PivotGridControl.Fields>
        </dxpg:PivotGridControl>
    </Grid>
</Window>

Imports Microsoft.VisualBasic
Imports System.Windows
Imports DevExpress.Xpf.PivotGrid

Namespace DXPivotGrid_SortBySummary
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            pivotGridControl1.DataSource = _
                (New nwindDataSetTableAdapters.SalesPersonTableAdapter()).GetData()
        End Sub
        Private Sub pivotGridControl1_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)

            ' Locks the pivot grid from updating while the Sort by Summary
            ' settings are being customized.
            pivotGridControl1.BeginUpdate()
            Try

                ' Specifies a data field whose summary values should be used to sort values
                ' of the Product Name field.
                fieldProductName.SortByField = fieldUnitPrice

                ' Specifies a column by which the Product Name field values should be sorted.
                fieldProductName.SortByConditions.Add(New SortByCondition(fieldYear, "1994"))
                fieldProductName.SortByConditions.Add(New SortByCondition(fieldMonth, "9"))
            Finally

                ' Unlocks the pivot grid and applies changes.
                pivotGridControl1.EndUpdate()
            End Try
        End Sub
    End Class
End Namespace

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

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.

VB.NET

how-to-sort-data-by-a-particular-column-or-row-e3090/VB/DXPivotGrid_SortBySummary/MainWindow.xaml.vb#L25

' Specifies a column by which the Product Name field values should be sorted.
fieldProductName.SortByConditions.Add(New SortByCondition(fieldYear, "1994"))
fieldProductName.SortByConditions.Add(New SortByCondition(fieldMonth, "9"))

how-to-implement-sorting-by-summary-in-olap-mode-e3093/VB/DXPivotGrid_OLAPSortBySummary/MainWindow.xaml.vb#L42

' Specifies a column by which the Month field values should be sorted.
fieldMonth.SortByConditions.Add(New SortByCondition(fieldCountry, _
                                "Australia", countryMember.UniqueName))