GridView.GetRelationIndex(Int32, String) Method

Gets the index of the specified relationship for the specified master row.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public virtual int GetRelationIndex(
    int rowHandle,
    string relationName
)

VB.NET

Public Overridable Function GetRelationIndex(
    rowHandle As Integer,
    relationName As String
) As Integer

Parameters

Name	Type	Description
rowHandle	Int32	An integer value specifying the master row handle.
relationName	String	A string identifying the name of the required relationship.

Returns

Type	Description
Int32	An integer representing the zero-based index of the specified relationship; -999999 if a relationship with the specified name is not found.

Remarks

The number of relations for a particular row is determined by the GridView.GetRelationCount method. The GetRelationIndex method returns a value between 0 and GetRelationCount-1 and this defines the specified relationship’s index amongst the other relationships. The indexes define the order in which detail Views are displayed for particular master rows.

To get the name of a relationship by its index, the GridView.GetRelationName method can be used.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetRelationIndex member must not be invoked for these Views. The GetRelationIndex 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 GetRelationIndex(Int32, String) 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-display-only-rows-with-non-empty-details-e465/CS/WindowsApplication28/Form1.cs#L45

int rowHandle = view.GetRowHandle(e.ListSourceRow);
e.Visible = !view.IsMasterRowEmptyEx(rowHandle, view.GetRelationIndex(rowHandle, "Detail"));
e.Handled = true;

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

else {
    view.SetMasterRowExpandedEx(rowHandle, view.GetRelationIndex(rowHandle, state.descriptor.relationName), true);
    GridView detail = view.GetVisibleDetailView(rowHandle) as GridView;

VB.NET

how-to-display-only-rows-with-non-empty-details-e465/VB/WindowsApplication28/Form1.vb#L41

Dim rowHandle As Integer = view.GetRowHandle(e.ListSourceRow)
e.Visible = Not view.IsMasterRowEmptyEx(rowHandle, view.GetRelationIndex(rowHandle, "Detail"))
e.Handled = True

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

Else
    view.SetMasterRowExpandedEx(rowHandle, view.GetRelationIndex(rowHandle, state.descriptor.relationName), True)
    Dim detail As GridView = TryCast(view.GetVisibleDetailView(rowHandle), GridView)