GridView.GetChildRowHandle(Int32, Int32) Method

Returns the handle of a group row’s child.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v23.2.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public int GetChildRowHandle(
    int rowHandle,
    int childIndex
)

VB.NET

Public Function GetChildRowHandle(
    rowHandle As Integer,
    childIndex As Integer
) As Integer

Parameters

Name	Type	Description
rowHandle	Int32	The handle of the group row whose immediate child row is to be obtained.
childIndex	Int32	A zero-based integer representing the desired child row’s index.

Returns

Type	Description
Int32	An integer value representing the child row handle. The GridControl.InvalidRowHandle field value if the specified row is a data row or the specified child row index is invalid.

Remarks

The GetChildRowHandle method should be used in combination with the GridView.GetChildRowCount method to traverse through the rows hierarchy. The latter method returns the number of a group row’s immediate children. After that has been obtained, you can pass values between 0 and the child row count decremented by one to the GetChildRowHandle method. This enables you to obtain handles of rows that belong to the group.

Please 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 GetChildRowHandle member must not be invoked for these Views. The GetChildRowHandle member can only be used with Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

• 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 GetChildRowHandle(Int32, 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-grid-multiple-row-selection-web-style-checkboxes/CS/E1271/CheckMarkSelection.cs#L70

for(int i = 0; i < _view.GetChildRowCount(rowHandle); i++) {
    int childRowHandle = _view.GetChildRowHandle(rowHandle, i);
    if(_view.IsGroupRow(childRowHandle))

winforms-grid-enable-editing-in-group-row-to-change-cell-values/CS/WindowsApplication3/GroupEditProvider.cs#L187

{
    int childRowHandle = view.GetChildRowHandle(groupRowHandle, i);
    view.SetRowCellValue(childRowHandle, fieldName, edit.EditValue);

VB.NET

winforms-grid-multiple-row-selection-web-style-checkboxes/VB/E1271/CheckMarkSelection.vb#L94

For i As Integer = 0 To _view.GetChildRowCount(rowHandle) - 1
    Dim childRowHandle As Integer = _view.GetChildRowHandle(rowHandle, i)
    If _view.IsGroupRow(childRowHandle) Then

winforms-grid-enable-editing-in-group-row-to-change-cell-values/VB/WindowsApplication3/GroupEditProvider.vb#L179

For i As Integer = 0 To childRowCount - 1
    Dim childRowHandle As Integer = view.GetChildRowHandle(groupRowHandle, i)
    view.SetRowCellValue(childRowHandle, fieldName, edit.EditValue)