PivotGridGroup Class

Represents an individual group of fields.

Namespace: DevExpress.Xpf.PivotGrid

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

Declaration

C#

public class PivotGridGroup :
    DXFrameworkContentElement,
    IEnumerable,
    IEnumerable<PivotGridField>

VB.NET

Public Class PivotGridGroup
    Inherits DXFrameworkContentElement
    Implements IEnumerable,
               IEnumerable(Of PivotGridField)

Related API Members

The following members return PivotGridGroup objects:

• IThreadSafeField.Group
• PivotGridField.Group
• PivotGridGroupCollection.Add()
• PivotGridGroupCollection.Add(PivotGridField[])
• PivotGroupEventArgs.Group

Remarks

The DXPivotGrid provides the capability to arrange fields into groups. Fields which are grouped cannot be separated by end-users by dragging one of them to a different area. Field groups are represented by the PivotGridGroup class and are stored within the PivotGridControl.Groups collection.

To learn more, see Field Groups.

Example

The following example demonstrates how to combine fields into a group.

In this example, three fields (“Country”, “Region” and “City”) are combined in a new group, in this order. This ensures that the “Country” field is followed by “Region”, which is in turn followed by “City”. If the “Region” field is dragged to another area, the other fields accompany it.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-group-fields-e2129.

MainWindow.xaml.cs

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

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);

            // Create a group at run-time
            PivotGridGroup group = pivotGridControl1.Groups.Add(fieldCategoryName, fieldProductName);
        }
    }
}

MainWindow.xaml

<Window x:Class="HowToBindToMDB.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid"
        Title="MainWindow" Height="350" Width="525"  Loaded="Window_Loaded">
    <Grid>
        <dxpg:PivotGridControl HorizontalAlignment="Left" Name="pivotGridControl1" 
                               VerticalAlignment="Top">
            <dxpg:PivotGridControl.Fields>
                <dxpg:PivotGridField Name="fieldCountry" FieldName="Country" Area="RowArea" 
                                     Group="{Binding ElementName=groupCountryCustomer}" />
                <dxpg:PivotGridField Name="fieldCustomer" FieldName="Sales Person" Area="RowArea" 
                                     Group="{Binding ElementName=groupCountryCustomer}" 
                                     Caption="Customer"/>
                <dxpg:PivotGridField Name="fieldYear" FieldName="OrderDate" Area="FilterArea"
                                     Caption="Year" GroupInterval="DateYear" />
                <dxpg:PivotGridField Name="fieldCategoryName" FieldName="CategoryName"
                                     Area="ColumnArea" Caption="Product Category" />
                <dxpg:PivotGridField Name="fieldProductName" FieldName="ProductName"
                                     Area="ColumnArea" Caption="Product Name" />
                <dxpg:PivotGridField Name="fieldExtendedPrice" FieldName="Extended Price"
                                     Area="DataArea" CellFormat="c0" />
            </dxpg:PivotGridControl.Fields>
            <dxpg:PivotGridControl.Groups>
                <dxpg:PivotGridGroup Name="groupCountryCustomer" />
            </dxpg:PivotGridControl.Groups>
        </dxpg:PivotGridControl>
    </Grid>
</Window>

MainWindow.xaml.vb

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

Namespace HowToBindToMDB
    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)
            ' Create a group at run-time
            Dim group As PivotGridGroup = _
                pivotGridControl1.Groups.Add(fieldCategoryName, fieldProductName)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotGridGroup class.

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.

VB.NET

how-to-group-fields-e2129/VB/HowToGroupFields/MainWindow.xaml.vb#L22

' Create a group at run-time
Dim group As PivotGridGroup = _
    pivotGridControl1.Groups.Add(fieldCategoryName, fieldProductName)

how-to-implement-group-filter-for-a-pivotgridcontrol-e4585/VB/GroupFilter/MainWindow.xaml.vb#L17

' Creates a group and adds two fields to it.
Dim OrderDateGroup As PivotGridGroup = pivotGridControl1.Groups.Add( _
    pivotGridControl1.Fields(2), pivotGridControl1.Fields(3))

C#

how-to-calculate-multiple-custom-totals-with-summarytype-set-to-custom-e3822/CS/DXPivotGrid_MultipleCustomTotals/MainWindow.xaml#L12

<dxpg:PivotGridControl.Groups>
    <dxpg:PivotGridGroup Name="group1"/>
    <dxpg:PivotGridGroup Name="group2"/>

how-to-implement-the-group-filter-for-a-pivotgrid-e2518/VB/DXPivotGrid_GroupFilter/MainWindow.xaml#L28

<dxpg:PivotGridControl.Groups>
    <dxpg:PivotGridGroup Name="group1" />
</dxpg:PivotGridControl.Groups>

how-to-bind-the-pivot-grid-to-fields-and-groups-specified-in-viewmodel-t521850/VB/WpfPivotTestExample/MainWindow.xaml#L45

<ContentControl>
    <dxpg:PivotGridGroup
        dx:XamlHelper.Name="{Binding Path=(dxci:DependencyObjectExtensions.DataContext).GroupName, RelativeSource={RelativeSource Self}}">

how-to-group-fields-e2129/VB/HowToGroupFields/MainWindow.xaml#L25

<dxpg:PivotGridControl.Groups>
    <dxpg:PivotGridGroup Name="groupCountryCustomer" />
</dxpg:PivotGridControl.Groups>

Inheritance

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

DXFrameworkContentElement

PivotGridGroup

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)