GridControl.GroupRowExpanding Event

Occurs when a group row is about to be expanded, allowing cancellation of the action.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event RowAllowEventHandler GroupRowExpanding

VB.NET

Public Event GroupRowExpanding As RowAllowEventHandler

Event Data

The GroupRowExpanding event's data class is RowAllowEventArgs. The following properties provide information specific to this event:

Property	Description
Allow	Gets or sets whether the operation is allowed.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Row	Gets the processed row. Inherited from RowEventArgs.
RowHandle	Gets the processed row’s handle. Inherited from RowEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The GroupRowExpanding event is raised before a group row is expanded by an end-user or in code, allowing you to cancel this action. The group row is identified by its handle via the RowEventArgs.RowHandle property. To prevent the group row from being expanded, set the event parameter’s RowAllowEventArgs.Allow parameter to false.

Group rows can be expanded recursively using the GridViewBase.ExpandFocusedRow method overload with the recursive parameter set to true. In this instance, the GroupRowExpanding event is raised only once (for the row passed as this method’s parameter). This event isn’t raised for nesting group rows.

The GridControl.ExpandAllGroups method allows you to expand all group rows. In this instance, the GroupRowExpanding event is raised only once. The event parameter’s RowEventArgs.RowHandle property returns an invalid row handle (DataControlBase.InvalidRowHandle).

After the group row has been expanded, the GridControl.GroupRowExpanded event is raised.

To learn more, see Expanding and Collapsing Group Rows.

Example

The following example does not allow users to collapse the Status: Invalidated group row and expand the Status: Delivered group row.

View Example: Forbid Expand and Collapse Operations for Group Rows

XAML

<dxg:GridControl x:Name="grid" 
                 EndGrouping="OnEndGrouping"
                 GroupRowCollapsing="OnGroupRowCollapsing"
                 GroupRowCollapsed="OnGroupRowCollapsed"
                 GroupRowExpanding="OnGroupRowExpanding"
                 GroupRowExpanded="OnGroupRowExpanded">
    <dxg:GridColumn FieldName="ProductName"/>
    <dxg:GridColumn FieldName="Price"/>
    <dxg:GridColumn FieldName="Discount"/>
    <dxg:GridColumn FieldName="Status" GroupIndex="0" SortOrder="Descending"/>
    <dxg:GridControl.View>
        <dxg:TableView x:Name="view" GroupValueTemplateSelector="{StaticResource groupRowTemplateSelector}"/>
    </dxg:GridControl.View>
</dxg:GridControl>

C#

void OnEndGrouping(object sender, RoutedEventArgs e) {
    if (grid.Columns[nameof(Invoice.Status)].GroupIndex == 0) {
        var childRow = grid.FindRowByValue(grid.Columns[nameof(Invoice.Status)], InvoiceStatus.Invalidated);
        var groupRow = grid.GetParentRowHandle(childRow);
        grid.ExpandGroupRow(groupRow);

        childRow = grid.FindRowByValue(grid.Columns[nameof(Invoice.Status)], InvoiceStatus.Delivered);
        groupRow = grid.GetParentRowHandle(childRow);
        grid.CollapseGroupRow(groupRow);
    }
}


void OnGroupRowCollapsing(object sender, RowAllowEventArgs e) {
    if (e.Row != null && grid.GetGroupRowValue(e.RowHandle).Equals(InvoiceStatus.Invalidated))
        e.Allow = false;
}
void OnGroupRowCollapsed(object sender, RowEventArgs e) {
    if (e.Row == null && grid.Columns[nameof(Invoice.Status)].GroupIndex == 0) {
        var childRow = grid.FindRowByValue(grid.Columns[nameof(Invoice.Status)], InvoiceStatus.Invalidated);
        var groupRow = grid.GetParentRowHandle(childRow);
        grid.ExpandGroupRow(groupRow);
    }
}


void OnGroupRowExpanding(object sender, RowAllowEventArgs e) {
    if (e.Row != null && grid.GetGroupRowValue(e.RowHandle).Equals(InvoiceStatus.Delivered))
        e.Allow = false;
}
void OnGroupRowExpanded(object sender, RowEventArgs e) {
    if (e.Row == null && grid.Columns[nameof(Invoice.Status)].GroupIndex == 0) {
        var childRow = grid.FindRowByValue(grid.Columns[nameof(Invoice.Status)], InvoiceStatus.Delivered);
        var groupRow = grid.GetParentRowHandle(childRow);
        grid.CollapseGroupRow(groupRow);
    }
}

VB.NET

Private Sub OnEndGrouping(ByVal sender As Object, ByVal e As RoutedEventArgs)
    If Me.grid.Columns(NameOf(Invoice.Status)).GroupIndex = 0 Then
        Dim childRow = Me.grid.FindRowByValue(Me.grid.Columns(NameOf(Invoice.Status)), InvoiceStatus.Invalidated)
        Dim groupRow = Me.grid.GetParentRowHandle(childRow)
        Me.grid.ExpandGroupRow(groupRow)
        childRow = Me.grid.FindRowByValue(Me.grid.Columns(NameOf(Invoice.Status)), InvoiceStatus.Delivered)
        groupRow = Me.grid.GetParentRowHandle(childRow)
        Me.grid.CollapseGroupRow(groupRow)
    End If
End Sub

Private Sub OnGroupRowCollapsing(ByVal sender As Object, ByVal e As RowAllowEventArgs)
    If e.Row IsNot Nothing AndAlso Me.grid.GetGroupRowValue(e.RowHandle).Equals(InvoiceStatus.Invalidated) Then e.Allow = False
End Sub

Private Sub OnGroupRowCollapsed(ByVal sender As Object, ByVal e As RowEventArgs)
    If e.Row Is Nothing AndAlso Me.grid.Columns(NameOf(Invoice.Status)).GroupIndex = 0 Then
        Dim childRow = Me.grid.FindRowByValue(Me.grid.Columns(NameOf(Invoice.Status)), InvoiceStatus.Invalidated)
        Dim groupRow = Me.grid.GetParentRowHandle(childRow)
        Me.grid.ExpandGroupRow(groupRow)
    End If
End Sub

Private Sub OnGroupRowExpanding(ByVal sender As Object, ByVal e As RowAllowEventArgs)
    If e.Row IsNot Nothing AndAlso Me.grid.GetGroupRowValue(e.RowHandle).Equals(InvoiceStatus.Delivered) Then e.Allow = False
End Sub

Private Sub OnGroupRowExpanded(ByVal sender As Object, ByVal e As RowEventArgs)
    If e.Row Is Nothing AndAlso Me.grid.Columns(NameOf(Invoice.Status)).GroupIndex = 0 Then
        Dim childRow = Me.grid.FindRowByValue(Me.grid.Columns(NameOf(Invoice.Status)), InvoiceStatus.Delivered)
        Dim groupRow = Me.grid.GetParentRowHandle(childRow)
        Me.grid.CollapseGroupRow(groupRow)
    End If
End Sub

Related GitHub Examples

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

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.

XAML

wpf-grid-prevent-expand-collapse-operations-for-group-rows/CS/Forbid_Expand_Collapse/MainWindow.xaml#L22

GroupRowCollapsed="OnGroupRowCollapsed"
GroupRowExpanding="OnGroupRowExpanding"
GroupRowExpanded="OnGroupRowExpanded">

C#

how-to-select-all-group-subitems-when-a-group-row-is-clicked-wpf-e4617/CS/GridGroupSelect/GroupChildSelector.cs#L21

    view.PreviewMouseLeftButtonUp += OnPreviewMouseLeftButtonUp;
    view.Grid.GroupRowExpanding += OnGroupRowExpanding;
}

VB.NET

how-to-select-all-group-subitems-when-a-group-row-is-clicked-wpf-e4617/VB/GridGroupSelect/GroupChildSelector.vb#L24

    AddHandler view.PreviewMouseLeftButtonUp, AddressOf OnPreviewMouseLeftButtonUp
    AddHandler view.Grid.GroupRowExpanding, AddressOf OnGroupRowExpanding
End Sub