GridView.GetRelationDisplayName(Int32, Int32) Method

Returns a detail clone’s caption.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

public virtual string GetRelationDisplayName(
    int rowHandle,
    int relationIndex
)

VB.NET

Public Overridable Function GetRelationDisplayName(
    rowHandle As Integer,
    relationIndex As Integer
) As String

Parameters

Name	Type	Description
rowHandle	Int32	An integer value specifying the master row by its handle.
relationIndex	Int32	A zero-based integer specifying the index of the relationship in the data source.

Returns

Type	Description
String	A string value representing the detail clone’s caption.

Remarks

This member supports the grid control’s internal infrastructure. Usually there is no need to use it directly.

Strings returned by the GetRelationDisplayName method identify detail clones in detail tabs and the detail tooltip. By default, the return value matches the detail clone’s corresponding relationship name. You can specify a custom display name for a View using the View’s BaseView.ViewCaption property or by handling the GridView.MasterRowGetRelationDisplayCaption event.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetRelationDisplayName(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-disable-particular-detail-tabs-in-a-master-detail-grid-e3334/CS/WindowsApplication3/MyGrid.cs#L105

    if (id < -1) continue;
    details.Add(new GridDetailInfo(id, node.RelationName, GetRelationDisplayName(rowHandle, id)));
}

VB.NET

how-disable-particular-detail-tabs-in-a-master-detail-grid-e3334/VB/WindowsApplication3/MyGrid.vb#L125

    End If
    details.Add(New GridDetailInfo(id, node.RelationName, GetRelationDisplayName(rowHandle, id)))
Next node