How to: Sort Filter Drop-Down Items in a Custom Manner

• Nov 13, 2018
• 2 minutes to read

The following example demonstrates how to sort filter drop-down items in a custom manner.

In this example, the CustomFilterPopupItems event is handled to manage a list of filter items. This event is raised when an end-user invokes the filter drop-down. The event parameter provides access to the filter items list, which is then sorted by the length of the items' captions (if the corresponding option is selected).

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-sort-filter-drop-down-items-in-a-custom-manner-e2682

Form1.cs

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

namespace XtraPivotGrid_ExampleTemplate {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }
        private void Form1_Load(object sender, EventArgs e) {
            DataSet1TableAdapters.ProductReportsTableAdapter tableAdapter =
                new DataSet1TableAdapters.ProductReportsTableAdapter();
            pivotGridControl1.DataSource = tableAdapter.GetData();
            pivotGridControl1.BestFit();
        }
        private void pivotGridControl1_CustomFilterPopupItems(object sender, 
            PivotCustomFilterPopupItemsEventArgs e) {
            if(rbCaptionLength.Checked)
                ArrayList.Adapter((IList)e.Items).Sort(new FilterItemsComparer());
        }
        private void rbAlphabeticalSort_CheckedChanged(object sender, EventArgs e) {
            fieldProductName.ShowFilterPopup();
        }
    }
    public class FilterItemsComparer : IComparer {
        int IComparer.Compare(object x, object y) {
            if (!(x is PivotGridFilterItem) || !(y is PivotGridFilterItem)) return 0;
            PivotGridFilterItem item1 = (PivotGridFilterItem)x;
            PivotGridFilterItem item2 = (PivotGridFilterItem)y;
            if (item1.ToString().Length == item2.ToString().Length) return 0;
            if (item1.ToString().Length > item2.ToString().Length) return 1;
            return -1;
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections
Imports System.Windows.Forms
Imports DevExpress.XtraPivotGrid
Imports DevExpress.XtraPivotGrid.Data

Namespace XtraPivotGrid_ExampleTemplate
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            Dim tableAdapter As New DataSet1TableAdapters.ProductReportsTableAdapter()
            pivotGridControl1.DataSource = tableAdapter.GetData()
            pivotGridControl1.BestFit()
        End Sub
        Private Sub pivotGridControl1_CustomFilterPopupItems(ByVal sender As Object, _
                ByVal e As PivotCustomFilterPopupItemsEventArgs) _
                Handles pivotGridControl1.CustomFilterPopupItems
            If rbCaptionLength.Checked Then
                ArrayList.Adapter(CType(e.Items, IList)).Sort(New FilterItemsComparer())
            End If
        End Sub
        Private Sub rbAlphabeticalSort_CheckedChanged(ByVal sender As Object, ByVal e As EventArgs) _
                Handles rbAlphabeticalSort.CheckedChanged
            fieldProductName.ShowFilterPopup()
        End Sub
    End Class
    Public Class FilterItemsComparer
        Implements IComparer
        Private Function IComparer_Compare(ByVal x As Object, ByVal y As Object) As Integer _
                Implements IComparer.Compare
            If Not(TypeOf x Is PivotGridFilterItem) OrElse Not(TypeOf y Is PivotGridFilterItem) Then
                Return 0
            End If
            Dim item1 As PivotGridFilterItem = CType(x, PivotGridFilterItem)
            Dim item2 As PivotGridFilterItem = CType(y, PivotGridFilterItem)
            If item1.ToString().Length = item2.ToString().Length Then
                Return 0
            End If
            If item1.ToString().Length > item2.ToString().Length Then
                Return 1
            End If
            Return -1
        End Function
    End Class
End Namespace