How to: Implement Group Filter for a PivotGrid

• Jun 27, 2019
• 2 minutes to read

This example demonstrates how to apply custom group filters to Pivot Grid Control data.

In this example, a filter type is defined by setting the PivotGroupFilterValues.FilterType property to PivotFilterType.Included. To create and add group filter values to the PivotGroupFilterValues.Values and PivotGroupFilterValue.ChildValues collections the PivotGroupFilterValuesCollection.Add method is used.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-implement-group-filter-for-a-pivotgridcontrol-e4581

Form1.cs

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

namespace GroupFilter {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {

            // Binds the pivot grid to data.
            this.salesPersonTableAdapter.Fill(this.nwindDataSet.SalesPerson);

            // Gets the field group from the collection.
            PivotGridGroup OrderDateGroup = pivotGridControl1.Groups[0];

            // Locks the PivotGroupFilterValues object by disabling visual updates.
            OrderDateGroup.FilterValues.BeginUpdate();

            // Sets the filter type. 
            // It specifies that the PivotGridControl should display only filter values.
            OrderDateGroup.FilterValues.FilterType = PivotFilterType.Included;

            // Creates a filter value and adds it to the PivotGroupFilterValues.Values collection.
            OrderDateGroup.FilterValues.Values.Add(new PivotGroupFilterValue(1994));

            // Creates a filter value and adds it to the PivotGroupFilterValues.Values collection.
            // Then creates a child value of the filter value and adds it to the parent value collection.
            OrderDateGroup.FilterValues.Values.Add(1995).ChildValues.Add(1);

            // Unlocks the PivotGroupFilterValues object.
            OrderDateGroup.FilterValues.EndUpdate();
        }
    }
}

Form1.vb

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

Namespace GroupFilter
    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

            ' Binds the pivot grid to data.
            Me.salesPersonTableAdapter.Fill(Me.nwindDataSet.SalesPerson)

            ' Gets the field group from the collection.
            Dim OrderDateGroup As PivotGridGroup = pivotGridControl1.Groups(0)

            ' Locks the PivotGroupFilterValues object by disabling visual updates.
            OrderDateGroup.FilterValues.BeginUpdate()

            ' Sets the filter type. 
            ' It specifies that the PivotGridControl should display only filter values.
            OrderDateGroup.FilterValues.FilterType = PivotFilterType.Included

            ' Creates a filter value and adds it to the PivotGroupFilterValues.Values collection.
            OrderDateGroup.FilterValues.Values.Add(New PivotGroupFilterValue(1994))

            ' Creates a filter value and adds it to the PivotGroupFilterValues.Values collection.
            ' Then creates a child value of the filter value and adds it to the parent value collection.
            OrderDateGroup.FilterValues.Values.Add(1995).ChildValues.Add(1)

            ' Unlocks the PivotGroupFilterValues object.
            OrderDateGroup.FilterValues.EndUpdate()
        End Sub
    End Class
End Namespace