ColumnView.GroupedColumns Property

Gets the collection of columns involved in data grouping.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[Browsable(false)]
public GridColumnReadOnlyCollection GroupedColumns { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property GroupedColumns As GridColumnReadOnlyCollection

Property Value

Type	Description
GridColumnReadOnlyCollection	A GridColumnReadOnlyCollection object representing a read-only collection of columns involved in grouping.

Remarks

When grouping data by values of a column, the column is automatically added to the GroupedColumns collection. When canceling grouping by this column’s values, the column is removed from the collection. Note that the column’s position within the collection matches the column’s GridColumn.GroupIndex property value.

To access all columns within a view, use the ColumnView.Columns property.

Related GitHub Examples

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

reporting-winforms-convert-grid-to-report/CS/XtraReport1.cs#L24

for(int i = gv.GroupCount-1; i >= 0; i--)
    InsertGroupBand(gv.GroupedColumns[i],i);
  for(int i=0;i<gv.Columns.Count;i++)

how-to-edit-values-within-a-group-via-an-editable-group-row-e3065/CS/EditableGroupRow/GroupRowEdit.cs#L88

View.BeginSort();
GridColumn grColumn = View.GroupedColumns[View.GetRowLevel(rowToChangeHandle)];
List<int> indexList = new List<int>();

how-to-hide-the-grid-columns-displayed-in-the-bands-when-grouping-is-applied-e653/CS/Form1.cs#L148

View = (AdvBandedGridView)sender;
foreach (BandedGridColumn Column in View.GroupedColumns)
{

how-to-show-tooltips-for-summaries-displayed-in-a-group-row-e3195/CS/GroupRowSummaryHelper.cs#L37

info.GroupText = string.Format("{0}: {1}", view.GroupedColumns[level].Caption,
    view.GetRowCellDisplayText(row, view.GroupedColumns[level]));
e.Appearance.DrawBackground(e.Cache, info.Bounds);

showing-tooltips-for-group-rows-in-the-grid-e989/CS/E989/GridViewGroupToolTipController.cs#L52

GridColumn GetColumnByGroupRowHandle(int rowHandle) {
    return View.GroupedColumns[View.GetRowLevel(rowHandle)];
}

VB.NET

reporting-winforms-convert-grid-to-report/VB/XtraReport1.vb#L25

For i As Integer = gv.GroupCount - 1 To 0 Step -1
    InsertGroupBand(gv.GroupedColumns(i), i)
Next

how-to-edit-values-within-a-group-via-an-editable-group-row-e3065/VB/EditableGroupRow/GroupRowEdit.vb#L76

View.BeginSort()
Dim grColumn As GridColumn = View.GroupedColumns(View.GetRowLevel(rowToChangeHandle))
Dim indexList As New List(Of Integer)()

how-to-hide-the-grid-columns-displayed-in-the-bands-when-grouping-is-applied-e653/VB/Form1.vb#L137

View = CType(sender, AdvBandedGridView)
For Each Column As BandedGridColumn In View.GroupedColumns
    Column.OwnerBand = Nothing

how-to-show-tooltips-for-summaries-displayed-in-a-group-row-e3195/VB/GroupRowSummaryHelper.vb#L34

Dim row As Integer = view.GetDataRowHandleByGroupRowHandle(e.RowHandle)
info.GroupText = String.Format("{0}: {1}", view.GroupedColumns(level).Caption, view.GetRowCellDisplayText(row, view.GroupedColumns(level)))
e.Appearance.DrawBackground(e.Cache, info.Bounds)

showing-tooltips-for-group-rows-in-the-grid-e989/VB/E989/GridViewGroupToolTipController.vb#L56

Private Function GetColumnByGroupRowHandle(ByVal rowHandle As Integer) As GridColumn
    Return View.GroupedColumns(View.GetRowLevel(rowHandle))
End Function