PivotGridGroupCollection Class

Represents a collection of field groups.

Namespace: DevExpress.Xpf.PivotGrid

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

Declaration

public class PivotGridGroupCollection :
    PivotChildCollection<PivotGridGroup>,
    ILockable
Public Class PivotGridGroupCollection
    Inherits PivotChildCollection(Of PivotGridGroup)
    Implements ILockable

Returned By

The PivotGridControl.Groups property returns an instance of PivotGridGroupCollection.

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 PivotGridGroup objects, and these are stored within the PivotGridControl.Groups collection.

To learn more, see Field Groups.

Examples

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

In this example, two fields ("Country" and "Customer") are combined into a new group at design time, and another two fields ("Category" and "Product") are combined into a new group at runtime, in this order. This ensures that the "Country" field is followed by "Customer", and the the "Category" field is followed by "Product". If you drag the "Region" field and drop it to another area, the "Customer" field accompanies it. This behavior is also true for the second group.

NOTE

A complete sample project How to: Group Fields is available at GitHub.

using System.Windows;
using DevExpress.Xpf.PivotGrid;
using HowToBindToMDB.DataSet1TableAdapters;
using static HowToBindToMDB.DataSet1;

namespace HowToBindToMDB {
    public partial class MainWindow : Window {
        SalesPersonDataTable salesPersonDataTable = 
            new 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);
        }
    }
}

Inheritance

Object
Collection<PivotGridGroup>
ObservableCollection<PivotGridGroup>
DevExpress.Xpf.PivotGrid.Internal.PivotChildCollection<PivotGridGroup>
PivotGridGroupCollection
See Also