GridView.GetDataRowHandleByGroupRowHandle(Int32) Method

Returns the handle of the first data row within a group.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public int GetDataRowHandleByGroupRowHandle(
    int groupRowHandle
)

VB.NET

Public Function GetDataRowHandleByGroupRowHandle(
    groupRowHandle As Integer
) As Integer

Parameters

Name	Type	Description
groupRowHandle	Int32	An integer value specifying the group row by its handle.

Returns

Type	Description
Int32	An integer value identifying the data row by its handle.

Remarks

The GetDataRowHandleByGroupRowHandle method searches all nesting hierarchy levels. This means that the row obtained is not necessarily the group row’s immediate child. Note that if the groupRowHandle parameter refers to a data row, the function simply returns the parameter value.

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

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetDataRowHandleByGroupRowHandle member must not be invoked for these Views. The GetDataRowHandleByGroupRowHandle member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Related GitHub Examples

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

winforms-preserve-grid-state-on-refresh/CS/RefreshHelperClass.cs#L92

if(dataRowHandle < 0) // group row
    dataRowHandle = view.GetDataRowHandleByGroupRowHandle(dataRowHandle);
rowInfo.Id = view.GetRowCellValue(dataRowHandle, column);

how-to-preserve-the-xtragrid-view-state-in-multi-level-master-detail-e1466/CS/RefreshHelperClass.cs#L171

if (handle < 0) // group row
    handle = view.GetDataRowHandleByGroupRowHandle(handle);
rowInfo.Id = view.GetRowCellValue(handle, descriptor.keyFieldName);

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

int level = view.GetRowLevel(e.RowHandle);
int row = view.GetDataRowHandleByGroupRowHandle(e.RowHandle);
info.GroupText = string.Format("{0}: {1}", view.GroupedColumns[level].Caption,

how-to-put-custom-rows-in-grid-control-e3367/CS/CustomRowInGrid/CustomRowInGrid/Form1.cs#L108

{
    int index = gridView1.GetDataRowHandleByGroupRowHandle(e.RowHandle);

VB.NET

winforms-preserve-grid-state-on-refresh/VB/RefreshHelperClass.vb#L99

rowInfo.level = view.GetRowLevel(dataRowHandle)
If dataRowHandle < 0 Then dataRowHandle = view.GetDataRowHandleByGroupRowHandle(dataRowHandle) ' group row
rowInfo.Id = view.GetRowCellValue(dataRowHandle, column)

how-to-preserve-the-xtragrid-view-state-in-multi-level-master-detail-e1466/VB/RefreshHelperClass.vb#L184

If handle < 0 Then ' group row
    handle = view.GetDataRowHandleByGroupRowHandle(handle)
End If

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

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

how-to-put-custom-rows-in-grid-control-e3367/VB/CustomRowInGrid/Form1.vb#L111

Private Sub gridView1_CustomDrawGroupRow(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs) Handles gridView1.CustomDrawGroupRow
    Dim index As Integer = gridView1.GetDataRowHandleByGroupRowHandle(e.RowHandle)