MasterRowGetRelationNameEventArgs.RelationName Property

For the GridView.MasterRowGetRelationName event this property gets or sets the name of the level whose bound View will be used to represent the currently processed detail’s data.

For the GridView.MasterRowGetRelationDisplayCaption event this property gets or sets the display caption for the currently processed relation.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public string RelationName { get; set; }

VB.NET

Public Property RelationName As String

Property Value

Type	Description
String	A string value specifying the name (or display name for the GridView.MasterRowGetRelationDisplayCaption event) of the level for the currently processed relation.

Remarks

When handling the GridView.MasterRowGetRelationName event, the RelationName property can be used to specify the View that will be used to represent the current detail clone. For relations defined by a data source, the RelationName property initially returns the name of the corresponding automatically generated level. For custom relations that are created by handling the GridView.MasterRowGetRelationCount event, the property’s value is initially an empty string.

Set the RelationName property to the name of a level residing within the GridControl.LevelTree tree. Each level has an associated View. This View will be used to represent the detail data for the current master row and relation index.

You can override the assigned value by handling the GridView.MasterRowGetLevelDefaultView event. This event receives the View that is specified by the RelationName property and enables it to be replaced with another View.

When handling the GridView.MasterRowGetRelationDisplayCaption event, the RelationName property can be used to specify the display caption for the processed relation (detail clone). This string will be displayed within detail tabs and detail tooltips. Initially this property contains a BaseView.ViewCaption string of the View that represents this relation. If BaseView.ViewCaption is set to an empty string, the RelationName property will initially contain the relationship’s name supplied via the GridView.MasterRowGetRelationName event.

Related GitHub Examples

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

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

    if (e.RowHandle == 0 && e.RelationIndex == 0)
        e.RelationName = "CustomRelation";
}

how-to-display-detail-views-under-each-other-e259/CS/DetailsUnderEachOther/Form1.cs#L49

private void gvMaster_MasterRowGetRelationName(object sender, DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs e) {
    e.RelationName = "Relations";
}

a-master-detail-grid-with-entity-framework-objects-e417/CS/CS/Entities/Form1.cs#L35

private void gridView1_MasterRowGetRelationName(object sender, DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs e) {
    e.RelationName = "Orders";
}

how-to-display-ef-objects-in-a-grid-within-master-detail-mode-when-entities-have-many-to-man-e2766/CS/Entities/Form1.cs#L27

private void OnMasterRowGetRelationName(object sender, DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs e) {
    e.RelationName = "Orders";
}

how-to-dynamically-load-and-refresh-detail-data-from-the-database-e1173/CS/WindowsApplication297/Form1.cs#L85

private void gridView1_MasterRowGetRelationName(object sender, DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs e) {
    e.RelationName = "Details";
}

VB.NET

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

If e.RowHandle = 0 AndAlso e.RelationIndex = 0 Then
    e.RelationName = "CustomRelation"
End If

how-to-display-detail-views-under-each-other-e259/VB/DetailsUnderEachOther/Form1.vb#L51

Private Sub gvMaster_MasterRowGetRelationName(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs) Handles gvMaster.MasterRowGetRelationName
    e.RelationName = "Relations"
End Sub

a-master-detail-grid-with-entity-framework-objects-e417/VB/CS/Entities/Form1.vb#L36

Private Sub gridView1_MasterRowGetRelationName(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs) Handles gridView1.MasterRowGetRelationName
    e.RelationName = "Orders"
End Sub

how-to-display-ef-objects-in-a-grid-within-master-detail-mode-when-entities-have-many-to-man-e2766/VB/Entities/Form1.vb#L29

Private Sub OnMasterRowGetRelationName(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs) Handles gridView1.MasterRowGetRelationName
    e.RelationName = "Orders"
End Sub

how-to-dynamically-load-and-refresh-detail-data-from-the-database-e1173/VB/WindowsApplication297/Form1.vb#L94

Private Sub gridView1_MasterRowGetRelationName(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationNameEventArgs) Handles gridView1.MasterRowGetRelationName
    e.RelationName = "Details"
End Sub