PivotGridControl.Groups Property

Gets the collection of field groups.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.2.dll

Declaration

C#

[Browsable(false)]
[XtraSerializableProperty(XtraSerializationVisibility.Collection, true, false, true, 100)]
[XtraSerializablePropertyId(3)]
public PivotGridGroupCollection Groups { get; }

VB.NET

<Browsable(False)>
<XtraSerializableProperty(XtraSerializationVisibility.Collection, True, False, True, 100)>
<XtraSerializablePropertyId(3)>
Public ReadOnly Property Groups As PivotGridGroupCollection

Property Value

Type	Description
PivotGridGroupCollection	A PivotGridGroupCollection object which represents a collection of field groups.

Remarks

Individual fields can be combined into a group which is represented by a PivotGridGroup object. If specific fields belong to a group they are treated as a whole and are always displayed within the same area. An end-user cannot separate these fields by dragging one of them to a different area or hiding it to the Customization Form.

Example

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

In the example three fields (‘Country’, ‘Region’ and ‘City’) are combined into a new group in that order. This ensures that the ‘Country’ field will be followed by ‘Region’ which is in turn followed by ‘City’. If the ‘Region’ field is being dragged to another area the other fields will be dragged as well. The following image shows the ‘Region’ field being dragged to the Filter Header Area.

C#

using DevExpress.XtraPivotGrid;

PivotGridField fieldCountry = pivotGridControl1.Fields["Country"];
PivotGridField fieldRegion = pivotGridControl1.Fields["Region"];
PivotGridField fieldCity = pivotGridControl1.Fields["City"];
// Add a new group which combines the fields.
pivotGridControl1.Groups.Add(new PivotGridField[] {fieldCountry, fieldRegion, fieldCity});

VB.NET

Imports DevExpress.XtraPivotGrid

Dim fieldCountry As PivotGridField = PivotGridControl1.Fields("Country")
Dim fieldRegion As PivotGridField = PivotGridControl1.Fields("Region")
Dim fieldCity As PivotGridField = PivotGridControl1.Fields["City")
' Add a new group which combines the fields.
PivotGridControl1.Groups.Add(new PivotGridField() {fieldCountry, fieldRegion, fieldCity})

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Groups 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#

how-to-generate-an-mdx-query-automatically-according-to-the-current-pivot-grid-layout-e2299/CS/WindowsApplication10/CubeToTableAdapte.cs#L56

List<GroupProperties> groups = new List<GroupProperties>();
foreach (PivotGridGroup g in pivot.Groups)
    groups.Add(new GroupProperties(g));

how-to-implement-group-filter-for-a-pivotgridcontrol-e4581/CS/GroupFilter/Form1.cs#L17

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

VB.NET

how-to-generate-an-mdx-query-automatically-according-to-the-current-pivot-grid-layout-e2299/VB/WindowsApplication10/CubeToTableAdapte.vb#L47

Dim groups As New List(Of GroupProperties)()
For Each g As PivotGridGroup In pivot.Groups
    groups.Add(New GroupProperties(g))

how-to-implement-group-filter-for-a-pivotgridcontrol-e4581/VB/GroupFilter/Form1.vb#L19

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