GridView.GroupRowExpanding Event

Occurs when a group row is about to be expanded.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[DXCategory("Behavior")]
public event RowAllowEventHandler GroupRowExpanding
<DXCategory("Behavior")>
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 a value specifying whether the current operation is allowed.
RowHandle Gets the row's handle (position). For the ColumnView.RowUpdated event, this property specifies the previous handle (position) of the currently processed row. Inherited from RowEventArgs.

Remarks

The GroupRowExpanding event is raised when an attempt to expand a group row is made. Note that it doesn't matter whether this is done by end-users or via code. The row about to be expanded can be identified using the RowEventArgs.RowHandle parameter. To stop the row from being expanded, set the RowAllowEventArgs.Allow parameter to false.

Group rows can be expanded recursively via the GridView.SetRowExpanded method overload with the recursive parameter set to true. In this case, the GroupRowExpanding event is raised only once (for the row passed as this method's parameter). For nesting rows, this event is not raised.

This event is also called when all group rows are expanded at the same time (via a group panel context menu or GridView.ExpandAllGroups method). In this case, the RowEventArgs.RowHandle parameter is set to GridControl.InvalidRowHandle.

Please refer to the Working with Groups in Code topic for additional information.

See Also