GridView.GetDetailView(Int32, Int32) Method

Gets the detail View for the master row.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public BaseView GetDetailView(
    int rowHandle,
    int relationIndex
)

VB.NET

Public Function GetDetailView(
    rowHandle As Integer,
    relationIndex As Integer
) As BaseView

Parameters

Name	Type	Description
rowHandle	Int32	The master row handle.
relationIndex	Int32	The relationship index in the data source.

Returns

Type	Description
BaseView	A BaseView descendant that is the detail clone. null (Nothing in Visual Basic) if the specified detail clone does not exist.

Remarks

You can obtain a detail View using the GetDetailView method only if this View is visible. The GridView.GetMasterRowExpanded method can be used to determine a master row’s expanded state. If a master row has several details, use the GridView.GetVisibleDetailRelationIndex method to identify the visible View’s relationship index. To obtain a detail View that is currently hidden, you first need to make this View visible via the GridView.SetMasterRowExpanded or GridView.SetMasterRowExpandedEx method.

The order of detail Views may not match the order of detail relationships in the data source. Take this into consideration when specifying the relationIndex parameter, which identifies the index of the relationship in the underlying data source.

To get the currently visible detail View, you can use the GridView.GetVisibleDetailView method instead of the GetDetailView method.

Refer to the Master-Detail Relationships and Working with Master-Detail Relationships in Code topics for additional information.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetDetailView member must not be invoked for these Views. The GetDetailView 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.

The code sample below illustrates how to add a custom editor to a detail view.

C#

using DevExpress.XtraEditors.Repository;
using DevExpress.XtraGrid.Views.Grid;

..

private void gridView1_MasterRowExpanded(object sender, DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs e)
{
    GridView dView = gridView1.GetDetailView(e.RowHandle, (sender as GridView).GetVisibleDetailRelationIndex(e.RowHandle)) as GridView;
    dView.CustomRowCellEdit += DView_CustomRowCellEdit;
    RepositoryItemComboBox cBox = new RepositoryItemComboBox();
    cBox.Items.AddRange(new string[] { "A", "B", "C", "D" });
    gridControl1.RepositoryItems.Add(cBox);
    dView.Columns["Col2"].ColumnEdit = cBox;
}

VB.NET

Imports DevExpress.XtraEditors.Repository
Imports DevExpress.XtraGrid.Views.Grid

..

private Sub gridView1_MasterRowExpanded(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs)
    Dim dView As GridView = TryCast(gridView1.GetDetailView(e.RowHandle, (TryCast(sender, GridView)).GetVisibleDetailRelationIndex(e.RowHandle)), GridView)
    dView.CustomRowCellEdit += DView_CustomRowCellEdit
    Dim cBox As New RepositoryItemComboBox()
    cBox.Items.AddRange(New String() { "A", "B", "C", "D" })
    gridControl1.RepositoryItems.Add(cBox)
    dView.Columns("Col2").ColumnEdit = cBox
End Sub

Related GitHub Examples

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

how-to-edit-all-the-records-in-the-detail-view-when-a-master-rows-value-is-changed-e624/CS/Form1.cs#L139

private void UpdateDetailView(int rowHandle, bool state) {
    GridView dView = gridView1.GetDetailView(rowHandle, 0) as GridView;
    bool aCollapsed = dView == null;

how-to-automatically-expand-the-detail-view-when-new-master-row-is-added-e1436/CS/Q205071/Form1.cs#L55

view.MasterRowExpanded -= OnGridViewMasterRowExpanded;
GridView childView = (GridView)view.GetDetailView(e.RowHandle, e.RelationIndex);
childView.AddNewRow();

how-to-hide-certain-records-in-the-xtragrids-detail-views-e684/CS/Form1.cs#L51

{
    GridView detailView = (sender as GridView).GetDetailView(e.RowHandle, e.RelationIndex) as GridView;
    detailView.ClearColumnsFilter();

how-to-show-a-treelistat-the-grids-detail-level-e2064/CS/Form1.cs#L81

{
    GridView view = gridView1.GetDetailView(e.RowHandle, e.RelationIndex) as GridView;
    UpdateTreeVisibility(view);

how-to-synchronize-a-data-bound-control-with-a-detail-grid-view-e612/CS/Sample/Form1.cs#L57

dataGrid.DataSource = null;
GridView detailView = gv.GetDetailView(e.FocusedRowHandle, 0) as GridView;
if (detailView == null)

VB.NET

how-to-edit-all-the-records-in-the-detail-view-when-a-master-rows-value-is-changed-e624/VB/Form1.vb#L134

Private Sub UpdateDetailView(ByVal rowHandle As Integer, ByVal state As Boolean)
    Dim dView As GridView = TryCast(gridView1.GetDetailView(rowHandle, 0), GridView)
    Dim aCollapsed As Boolean = dView Is Nothing

how-to-automatically-expand-the-detail-view-when-new-master-row-is-added-e1436/VB/Q205071/Form1.vb#L62

RemoveHandler view.MasterRowExpanded, AddressOf OnGridViewMasterRowExpanded
Dim childView As GridView = CType(view.GetDetailView(e.RowHandle, e.RelationIndex), GridView)
childView.AddNewRow()

how-to-hide-certain-records-in-the-xtragrids-detail-views-e684/VB/Form1.vb#L45

Private Sub gridView1_MasterRowExpanded(ByVal sender As Object, ByVal e As CustomMasterRowEventArgs) Handles gridView1.MasterRowExpanded
    Dim detailView As GridView = TryCast((TryCast(sender, GridView)).GetDetailView(e.RowHandle, e.RelationIndex), GridView)
    detailView.ClearColumnsFilter()

how-to-show-a-treelistat-the-grids-detail-level-e2064/VB/Form1.vb#L70

Private Sub gridView1_MasterRowExpanded(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.CustomMasterRowEventArgs) Handles gridView1.MasterRowExpanded
    Dim view As GridView = TryCast(gridView1.GetDetailView(e.RowHandle, e.RelationIndex), GridView)
    UpdateTreeVisibility(view)

how-to-synchronize-a-data-bound-control-with-a-detail-grid-view-e612/VB/Sample/Form1.vb#L55

dataGrid.DataSource = Nothing
Dim detailView As GridView = TryCast(gv.GetDetailView(e.FocusedRowHandle, 0), GridView)
If detailView Is Nothing Then