CustomMasterRowEventArgs.RelationIndex Property

Gets the relation index that identifies the affected detail.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public int RelationIndex { get; }

VB.NET

Public ReadOnly Property RelationIndex As Integer

Property Value

Type	Description
Int32	An integer value specifying the relation index.

Remarks

Master rows can have several detail Views. In such cases, you will need to determine the detail clone affected when handling operations on master rows. Use the RelationIndex property for this purpose. The number of details for a specific row is determined by the GridView.GetRelationCount method.

You can determine the relation name by the relation index using the View’s GridView.GetRelationName method. The corresponding detail View clone can be obtained using the GridView.GetDetailView method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RelationIndex property.

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#

multiple-selection-using-checkbox-in-a-master-detail-grid-e3507/CS/E3507/CheckMarkSelection.cs#L265

void view_MasterRowExpanded(object sender, CustomMasterRowEventArgs e) {
    GridView detailView = View.GetDetailView(e.RowHandle, e.RelationIndex) as GridView;
    GridCheckMarksSelection detailHelper = GetDetailSelectionHelper(e.RowHandle, e.RelationIndex);

providing-custom-pattern-views-to-represent-individual-master-detail-relationships-e3861/CS/Form1.cs#L34

private void advBandedGridView1_MasterRowGetRelationName(object sender, MasterRowGetRelationNameEventArgs e) {
    if (e.RowHandle == 0 && e.RelationIndex == 0)
        e.RelationName = "CustomRelation";

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);

VB.NET

multiple-selection-using-checkbox-in-a-master-detail-grid-e3507/VB/E3507/CheckMarkSelection.vb#L310

Private Sub view_MasterRowExpanded(ByVal sender As Object, ByVal e As CustomMasterRowEventArgs)
    Dim detailView As GridView = TryCast(View.GetDetailView(e.RowHandle, e.RelationIndex), GridView)
    Dim detailHelper As GridCheckMarksSelection = GetDetailSelectionHelper(e.RowHandle, e.RelationIndex)

providing-custom-pattern-views-to-represent-individual-master-detail-relationships-e3861/VB/Form1.vb#L36

Private Sub advBandedGridView1_MasterRowGetRelationName(ByVal sender As Object, ByVal e As MasterRowGetRelationNameEventArgs) Handles advBandedGridView1.MasterRowGetRelationName
    If e.RowHandle = 0 AndAlso e.RelationIndex = 0 Then
        e.RelationName = "CustomRelation"

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)