How to: Sort Data in Server Mode Using Custom Sorting Algorithm

• Jun 27, 2019
• 3 minutes to read

This example demonstrates how to implement a custom sorting algorithm by handling the PivotGridControl.CustomServerModeSort event. The “Month” column field is sorted by the “Produce” row using the cross area key, and the “Category” field is sorted directly by the year 1996.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264145

Form1.cs

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

namespace WinFormsPivotGridCustomServerModeSort
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
            entityServerModeSource.QueryableSource = new 
                WinFormsPivotGridCustomServerModeSort.NWindEntities1().SalesPersons;

            PivotGridField field = fieldOrderYear;
            pivotGridControl1.BeginUpdate();
            try
            {
                field.FilterValues.Clear();
                field.FilterValues.Add(1996);
                field.FilterValues.FilterType = PivotFilterType.Included;
            }
            finally
            {
                pivotGridControl1.EndUpdate();
            }

            // Sets fields' sort mode to Custom to raise the CustomServerModeSort event.
            fieldCategoryName.SortMode = PivotSortMode.Custom;
            fieldOrderMonth.SortMode = PivotSortMode.Custom;

        }

        private void pivotGridControl1_CustomServerModeSort(object sender, 
            CustomServerModeSortEventArgs e)
        {
            // Sorting using a cross area object.
            if (e.Field == fieldOrderMonth)
            {
                // Sets the cross area key, by which the "Month" field will be sorted. 
                // In this example, it's one of the "Category" cross area field values.
                CrossAreaKey sorting = e.GetCrossAreaKey(new object[] { "Produce" });

                // Sets the result of the "Month" field's values comparison 
                // by the cross area key object and the "Price" field.
                e.Result = Comparer.Default.Compare(
                    e.GetCellValue1(sorting, fieldPrice),
                    e.GetCellValue2(sorting, fieldPrice)
                );
            }

            // Direct sorting without using a cross area object. 
            if (e.Field == fieldCategoryName)
            {
                // Sets the result of "Category" field's values comparison by the Year and Price fields.
                e.Result = Comparer.Default.Compare(
                    e.GetCellValue1(new object[] { 1996 }, fieldPrice),
                    e.GetCellValue2(new object[] { 1996 }, fieldPrice)
                );
            }
        }
    }
}

Form1.vb

Imports System.Windows.Forms
Imports DevExpress.XtraPivotGrid
Imports System.Collections

Namespace WinFormsPivotGridCustomServerModeSort
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            entityServerModeSource.QueryableSource =
                (New WinFormsPivotGridCustomServerModeSort.NWindEntities1()).SalesPersons

            Dim field As PivotGridField = fieldOrderYear
            pivotGridControl1.BeginUpdate()
            Try
                field.FilterValues.Clear()
                field.FilterValues.Add(1996)
                field.FilterValues.FilterType = PivotFilterType.Included
            Finally
                pivotGridControl1.EndUpdate()
            End Try

            ' Sets fields' sort mode to Custom to raise the CustomServerModeSort event.
            fieldCategoryName.SortMode = PivotSortMode.Custom
            fieldOrderMonth.SortMode = PivotSortMode.Custom

        End Sub

        Private Sub pivotGridControl1_CustomServerModeSort(ByVal sender As Object, 
            ByVal e As CustomServerModeSortEventArgs) Handles pivotGridControl1.CustomServerModeSort
            ' Sorting using a cross area object.
            If e.Field Is fieldOrderMonth Then
                ' Sets the cross area key, by which the "Month" field will be sorted. 
                ' In this example, it's one of the "Category" cross area field values.
                Dim sorting As CrossAreaKey = e.GetCrossAreaKey(New Object() { "Produce" })

                ' Sets the result of the "Month" field's values comparison 
                ' by the cross area key object and the "Price" field.
                e.Result = Comparer.Default.Compare(
                    e.GetCellValue1(sorting, fieldPrice), 
                    e.GetCellValue2(sorting, fieldPrice))
            End If

            ' Direct sorting without using a cross area object. 
            If e.Field Is fieldCategoryName Then
                ' Sets the result of "Category" field's values comparison by the Year and Price fields.
                e.Result = Comparer.Default.Compare(
                    e.GetCellValue1(New Object() { 1996 }, fieldPrice), 
                    e.GetCellValue2(New Object() { 1996 }, fieldPrice))
            End If
        End Sub
    End Class
End Namespace