PivotCustomGroupIntervalEventArgs.GroupValue Property

Gets or sets a group value.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.PivotGrid, DevExpress.Wpf.PivotGrid

Declaration

C#

public object GroupValue { get; set; }

VB.NET

Public Property GroupValue As Object

Property Value

Type	Description
Object	An object that represents the group value.

Remarks

The PivotGridControl.CustomGroupInterval event enables you to group axis values using your own criteria. Use the GroupValue property to specify group values.

Example

This example shows how to implement custom Group Intervals.

View Example

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System.Data
Imports System.Data.OleDb
Imports System.Windows
Imports DevExpress.Xpf.PivotGrid
Imports HowToBindToMDB.NwindDataSetTableAdapters
Imports System

Namespace HowToBindToMDB
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window
        Private salesPersonDataTable As New NwindDataSet.SalesPersonDataTable()
        Private salesPersonDataAdapter As New SalesPersonTableAdapter()

        Public Sub New()
            InitializeComponent()
            pivotGridControl1.DataSource = salesPersonDataTable
        End Sub

        Private Sub Window_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
            salesPersonDataAdapter.Fill(salesPersonDataTable)
            pivotGridControl1.CollapseAllRows()
        End Sub

        Private Sub pivotGridControl1_CustomGroupInterval(ByVal sender As Object, _
                                                          ByVal e As PivotCustomGroupIntervalEventArgs)
            If (Not Object.ReferenceEquals(e.Field, fieldProductGroup)) Then
                Return
            End If
            Dim productName As String = Convert.ToString(e.Value)
            If productName.Chars(0) < "F"c Then
                e.GroupValue = "A-E"
            ElseIf productName.Chars(0) > "E"c AndAlso productName.Chars(0) < "T"c Then
                e.GroupValue = "F-S"
            ElseIf productName.Chars(0) > "S"c Then
                e.GroupValue = "T-Z"
            End If
        End Sub
    End Class
End Namespace

MainWindow.xaml

<Window xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid" 
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
        Title="MainWindow" Height="350" Width="525"
        x:Class="HowToBindToMDB.MainWindow" 
        Loaded="Window_Loaded">
    <Grid>
        <dxpg:PivotGridControl CustomGroupInterval="pivotGridControl1_CustomGroupInterval"
                               HorizontalAlignment="Left" Name="pivotGridControl1"
                               VerticalAlignment="Top">
            <dxpg:PivotGridControl.Fields>
                <dxpg:PivotGridField Name="fieldProductGroup" FieldName="ProductName" Area="RowArea"
                                     Caption="Product Group" GroupInterval="Custom" />
                <dxpg:PivotGridField Name="fieldProductName" FieldName="ProductName" Area="RowArea"
                                     Caption="Product Name" />
                <dxpg:PivotGridField Name="fieldExtendedPrice" FieldName="Extended Price"
                                     Area="DataArea" CellFormat="c0" />
            </dxpg:PivotGridControl.Fields>
        </dxpg:PivotGridControl>
    </Grid>
</Window>

MainWindow.xaml.cs

using System.Data;
using System.Data.OleDb;
using System.Windows;
using DevExpress.Xpf.PivotGrid;
using HowToBindToMDB.NwindDataSetTableAdapters;
using System;

namespace HowToBindToMDB {
    public partial class MainWindow : Window {
        NwindDataSet.SalesPersonDataTable salesPersonDataTable = 
            new NwindDataSet.SalesPersonDataTable();
        SalesPersonTableAdapter salesPersonDataAdapter = 
            new SalesPersonTableAdapter();

        public MainWindow() {
            InitializeComponent();
            pivotGridControl1.DataSource = salesPersonDataTable;
        }

        private void Window_Loaded(object sender, RoutedEventArgs e) {
            salesPersonDataAdapter.Fill(salesPersonDataTable);
            pivotGridControl1.CollapseAllRows();
        }

        private void pivotGridControl1_CustomGroupInterval(object sender, 
                PivotCustomGroupIntervalEventArgs e) {
            if(!object.ReferenceEquals(e.Field, fieldProductGroup)) return;
            string productName = Convert.ToString(e.Value);
            if(productName[0] < 'F')
                e.GroupValue = "A-E";
            else if(productName[0] > 'E' && productName[0] < 'T')
                e.GroupValue = "F-S";
            else if(productName[0] > 'S')
                e.GroupValue = "T-Z";
        }
    }
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GroupValue property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-pivot-custom-group-intervals/CS/HowToCustomGroupInterval/MainWindow.xaml.cs#L30

if(productName[0] < 'F')
    e.GroupValue = "A-E";
else if(productName[0] > 'E' && productName[0] < 'T')

VB.NET

wpf-pivot-custom-group-intervals/VB/HowToCustomGroupInterval/MainWindow.xaml.vb#L29

If productName(0) < "F"c Then
    e.GroupValue = "A-E"
ElseIf productName(0) > "E"c AndAlso productName(0) < "T"c Then