How to: Implement Custom Sorting

• Aug 01, 2019
• 3 minutes to read

This example demonstrates how to implement custom sorting in the Grid Control. To do this, handle the GridControl.CustomColumnSort event, assign your custom sorted list to the e.Result property and set the e.Handled property to True.

XAML

<Page
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:CustomSorting"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:Grid="using:DevExpress.UI.Xaml.Grid"
    x:Class="CustomSorting.MainPage"
    mc:Ignorable="d">
    <Grid >
        <Grid.RowDefinitions>
            <RowDefinition Height="40" />
            <RowDefinition Height="*" />
        </Grid.RowDefinitions>
        <CheckBox Grid.Row="0" VerticalAlignment="Center" HorizontalAlignment="Center" Content="Custom Sort" Checked="CheckBox_Checked" Unchecked="CheckBox_Unchecked" />
        <Grid:GridControl Grid.Row="1" Name="grid" AutoGenerateColumns="True" NavigationStyle="None"
                          CustomColumnSort="grid_CustomColumnSort" />
    </Grid>
</Page>

C#

using System.Collections.Generic;
using System.Collections.ObjectModel;
using DevExpress.XtraGrid;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;

namespace CustomSorting {
    public sealed partial class MainPage : Page {
        public MainPage() {
            this.InitializeComponent();
            grid.ItemsSource = new MonthList();
            grid.SortBy(grid.Columns[0]);
        }

        private void CheckBox_Checked(object sender, RoutedEventArgs e) {
            grid.Columns[0].SortMode = ColumnSortMode.Custom;
        }

        private void CheckBox_Unchecked(object sender, RoutedEventArgs e) {
            grid.Columns[0].SortMode = ColumnSortMode.Default;
        }

        private void grid_CustomColumnSort(object sender, DevExpress.UI.Xaml.Grid.CustomColumnSortEventArgs e) {
            e.Result = Comparer<int>.Default.Compare(e.ListSourceRowIndex1, e.ListSourceRowIndex2);

            e.Handled = true;
        }
    }
    public class Month {
        public string month { get; set; }
    }
    public class MonthList : ObservableCollection<Month> {
        public MonthList()
            : base() {
            Add(new Month() { month = "January" });
            Add(new Month() { month = "February" });
            Add(new Month() { month = "March" });
            Add(new Month() { month = "April" });
            Add(new Month() { month = "May" });
            Add(new Month() { month = "June" });
            Add(new Month() { month = "July" });
            Add(new Month() { month = "August" });
            Add(new Month() { month = "September" });
            Add(new Month() { month = "October" });
            Add(new Month() { month = "November" });
            Add(new Month() { month = "December" });
        }
    }
}

VB.NET

Imports DevExpress.XtraGrid

Public NotInheritable Class MainPage
    Inherits Page
    Public Sub New()
        Me.InitializeComponent()
        grid.ItemsSource = New MonthList()
        grid.SortBy(grid.Columns(0))
    End Sub

    Private Sub CheckBox_Checked(ByVal sender As Object, ByVal e As RoutedEventArgs)
        grid.Columns(0).SortMode = ColumnSortMode.Custom
    End Sub

    Private Sub CheckBox_Unchecked(ByVal sender As Object, ByVal e As RoutedEventArgs)
        grid.Columns(0).SortMode = ColumnSortMode.Default
    End Sub

    Private Sub grid_CustomColumnSort(ByVal sender As Object, ByVal e As DevExpress.UI.Xaml.Grid.CustomColumnSortEventArgs)
        e.Result = Comparer(Of Integer).Default.Compare(e.ListSourceRowIndex1, e.ListSourceRowIndex2)

        e.Handled = True
    End Sub
    Public Class Month
        Private privatemonth As String
        Public Property month() As String
            Get
                Return privatemonth
            End Get
            Set(ByVal value As String)
                privatemonth = value
            End Set
        End Property
    End Class
    Public Class MonthList
        Inherits ObservableCollection(Of Month)
        Public Sub New()
            MyBase.New()
            Add(New Month() With {.month = "January"})
            Add(New Month() With {.month = "February"})
            Add(New Month() With {.month = "March"})
            Add(New Month() With {.month = "April"})
            Add(New Month() With {.month = "May"})
            Add(New Month() With {.month = "June"})
            Add(New Month() With {.month = "July"})
            Add(New Month() With {.month = "August"})
            Add(New Month() With {.month = "September"})
            Add(New Month() With {.month = "October"})
            Add(New Month() With {.month = "November"})
            Add(New Month() With {.month = "December"})
        End Sub
    End Class
End Class