MasterRowGetRelationNameEventArgs Class

Provides data for the GridView.MasterRowGetRelationName event.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

public class MasterRowGetRelationNameEventArgs :
    CustomMasterRowEventArgs

VB.NET

Public Class MasterRowGetRelationNameEventArgs
    Inherits CustomMasterRowEventArgs

Related API Members

MasterRowGetRelationNameEventArgs is the data class for the following events:

• GridView.MasterRowGetRelationDisplayCaption
• GridView.MasterRowGetRelationName

Remarks

The GridView.MasterRowGetRelationName event enables you to specify the level from the GridControl.LevelTreetree that will be used to represent data for a particular detail. Thus, the MasterRowGetRelationNameEventArgs class provides properties identifying the processed detail and specifying the associated level name. The currently processed detail is identified using the inherited CustomMasterRowEventArgs.RowHandle and CustomMasterRowEventArgs.RelationIndex properties. The MasterRowGetRelationNameEventArgs.RelationName property specifies the level associated with the current detail.

MasterRowGetRelationNameEventArgs objects are automatically created, initialized and passed to GridView.MasterRowGetRelationName event handlers.

Related GitHub Examples

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

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#L33

// Provide a pattern View for the first master-detail relationship in the first master row
private void advBandedGridView1_MasterRowGetRelationName(object sender, MasterRowGetRelationNameEventArgs e) {
    if (e.RowHandle == 0 && e.RelationIndex == 0)

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

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#L34

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#L26

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#L84

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#L35

' Provide a pattern View for the first master-detail relationship in the first master row
Private Sub advBandedGridView1_MasterRowGetRelationName(ByVal sender As Object, ByVal e As MasterRowGetRelationNameEventArgs) Handles advBandedGridView1.MasterRowGetRelationName
    If e.RowHandle = 0 AndAlso e.RelationIndex = 0 Then

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

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

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

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

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

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

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

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

Inheritance

Object

EventArgs

CustomMasterRowEventArgs

MasterRowGetRelationNameEventArgs