GridControl.IsGroupRowHandle(Int32) Method

Indicates whether the specified handle corresponds to a group row.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public bool IsGroupRowHandle(
    int rowHandle
)

VB.NET

Public Function IsGroupRowHandle(
    rowHandle As Integer
) As Boolean

Parameters

Name	Type	Description
rowHandle	Int32	An integer value that specifies the row’s handle.

Returns

Type	Description
Boolean	true if the specified handle corresponds to a group row; otherwise, false.

Remarks

Group row handles are negative (start from -1). The IsGroupRowHandle method returns false, if the specified handle corresponds to a data row or invalid row.

To learn more, see Grouping and Identifying Rows and Cards.

Example

The following example demonstrates how to use the TableView.RowDoubleClick event to process double-clicks:

View Example: How to Handle Row Double-clicks

MainWindow.xaml

<dxg:GridControl x:Name="grid">
<!-- ... -->
    <dxg:GridControl.View>
        <dxg:TableView RowDoubleClick="OnRowDoubleClick"/>
    </dxg:GridControl.View>
</dxg:GridControl>

MainWindow.xaml.cs

void OnRowDoubleClick(object sender, RowDoubleClickEventArgs e) {
    int rowHandle = e.HitInfo.RowHandle;
    if(rowHandle == GridControl.InvalidRowHandle)
        return;
    if(grid.IsGroupRowHandle(rowHandle))
        MessageBox.Show("A group row has been double clicked.", "Info");
    else
        MessageBox.Show("A data row has been double clicked.", "Info");
}

MainWindow.xaml.vb

Private Sub OnRowDoubleClick(ByVal sender As Object, ByVal e As RowDoubleClickEventArgs)
    Dim rowHandle As Integer = e.HitInfo.RowHandle
    If rowHandle = DataControlBase.InvalidRowHandle Then Return
    If Me.grid.IsGroupRowHandle(rowHandle) Then
        MessageBox.Show("A group row has been double clicked.", "Info")
    Else
        MessageBox.Show("A data row has been double clicked.", "Info")
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IsGroupRowHandle(Int32) method.

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-select-all-group-subitems-when-a-group-row-is-clicked-wpf-e4617/CS/GridGroupSelect/GroupChildSelector.cs#L33

TableViewHitInfo hitInfo = view.CalcHitInfo(e.OriginalSource as DependencyObject);
if (hitInfo.InRow && view.Grid.IsGroupRowHandle(hitInfo.RowHandle)) {
    view.Grid.BeginSelection();

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/CS/DevExpress.Example01/SearchBehavior/SearchWindow.xaml.cs#L231

int rowHandle = this._Grid.GetRowHandleByVisibleIndex(i);
if(this._Grid.IsGroupRowHandle(rowHandle)) {
    if(!this._Grid.IsGroupRowExpanded(rowHandle)) {

VB.NET

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

Dim hitInfo As TableViewHitInfo = view.CalcHitInfo(TryCast(e.OriginalSource, DependencyObject))
If hitInfo.InRow AndAlso view.Grid.IsGroupRowHandle(hitInfo.RowHandle) Then
    view.Grid.BeginSelection()

how-to-create-search-window-with-find-previous-and-find-next-buttons-in-gridcontrol-t127527/VB/DevExpress.Example01/SearchBehavior/SearchWindow.xaml.vb#L225

Dim rowHandle As Integer = _Grid.GetRowHandleByVisibleIndex(i)
If _Grid.IsGroupRowHandle(rowHandle) Then
    If Not _Grid.IsGroupRowExpanded(rowHandle) Then