GridView.GetRelationDisplayName(Int32, Int32) Method

Returns a detail clone's caption.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public virtual string GetRelationDisplayName(
    int rowHandle,
    int relationIndex
)
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.

See Also