PivotGridFieldSortCondition(PivotGridFieldBase, Object, String) Constructor

Initializes a new instance of the PivotGridFieldSortCondition class.

Namespace: DevExpress.XtraPivotGrid

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


public PivotGridFieldSortCondition(
    PivotGridFieldBase field,
    object value,
    string olapUniqueName


Name Type Description
field PivotGridFieldBase

A PivotGridFieldBase descendant that represents the field to which the condition corresponds. This value is assigned to the PivotGridFieldSortCondition.Field property.

value Object

An object that specifies the field value represented by the condition. This value is assigned to the PivotGridFieldSortCondition.Value property.

olapUniqueName String

A String that represents the unique name of the corresponding OLAP member. This value is assigned to the PivotGridFieldSortCondition.OLAPUniqueMemberName property.


The following example demonstrates how to implement Sorting by Summary in OLAP mode.

In this example, values of the Semester field are sorted by the Australia | Bendigo column summary values. To do this, two sort conditions represented by PivotGridFieldSortCondition instances are created. One of them represents an OLAP member that corresponds to the ‘Australia’ value, while another corresponds to the ‘Bendigo’ value. These sort conditions are added to the Semester field’s PivotGridFieldSortBySummaryInfo.Conditions collection to specify the column by which Semester values should be sorted. A data field that identifies the column is specified via the PivotGridFieldSortBySummaryInfo.Field property.

OLAP members corresponding to the Australia and Bendigo values are obtained using the PivotGridControl.GetFieldValueOLAPMember method. Note that OLAP members can be obtained only for visible field values. For this reason, the Australia field value is expanded before initializing OLAP members in order to obtain the Bendigo OLAP member.

This sample uses the Adventure Works 2008 cube.

using System;
using System.Windows.Forms;
using DevExpress.XtraPivotGrid;

namespace XtraPivotGrid_OLAPSortBySummary {
    public partial class Form1 : Form {
        public Form1() {
        private void Form1_Load(object sender, EventArgs e) {
            // Expands the Australia column to be able to retrieve OLAP members 
            // that correspond to the nested columns.
            pivotGridControl1.ExpandValue(true, new object[] { "Australia" });

            // Obtains OLAP members corresponding to the Australia and Bendigo values.
            IOLAPMember countryMember = pivotGridControl1.GetFieldValueOLAPMember(fieldCountry, 0);
            IOLAPMember cityMember = pivotGridControl1.GetFieldValueOLAPMember(fieldCity, 0);

            // Exits if the OLAP members were not obtained successfully.
            if (countryMember == null || cityMember == null)

            // Locks the pivot grid from updating while the Sort by Summary
            // settings are being customized.
            try {

                // Specifies a data field whose summary values should be used to sort values
                // of the Fiscal Year field.
                fieldFiscalYear.SortBySummaryInfo.Field = fieldInternetSalesAmount;

                // Specifies a column by which the Fiscal Year field values should be sorted.
                    new PivotGridFieldSortCondition(fieldCountry, "Australia", countryMember.UniqueName));
                    new PivotGridFieldSortCondition(fieldCity, "Bendigo", cityMember.UniqueName));
            finally {
                // Unlocks the pivot grid and applies changes.
See Also