GridView.MasterRowGetChildList Event

Enables you to supply detail data manually.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.1.dll

Declaration

C#

[DXCategory("MasterDetail")]
public event MasterRowGetChildListEventHandler MasterRowGetChildList

VB.NET

<DXCategory("MasterDetail")>
Public Event MasterRowGetChildList As MasterRowGetChildListEventHandler

Event Data

The MasterRowGetChildList event's data class is MasterRowGetChildListEventArgs. The following properties provide information specific to this event:

Property	Description
ChildList	Gets or sets a detail clone’s record list.
RelationIndex	Gets the relation index that identifies the affected detail. Inherited from CustomMasterRowEventArgs.
RowHandle	Gets the handle of the currently processed master row in the current View. Inherited from CustomMasterRowEventArgs.

Remarks

The MasterRowGetChildList event is raised when a particular detail is about to be created. The event’s CustomMasterRowEventArgs.RowHandle and CustomMasterRowEventArgs.RelationIndex parameters identify the detail. To provide custom data for this detail, assign a proper list to the MasterRowGetChildListEventArgs.ChildList parameter.

The MasterRowGetChildList event can be used for the following purposes:

• substitute the actual detail data with data supplied manually;
• supply data to details that have no initial data (implement dynamic data loading). In this case, you will also need to handle the GridView.MasterRowGetRelationCount, GridView.MasterRowGetRelationName and GridView.MasterRowEmpty events. Please refer to the Working with Master-Detail Relationships in Code topic for details.

The MasterRowGetChildList event may fire multiple times for a single row during an application run. Moreover, in specific instances, the MasterRowGetChildList event fires twice when a row is expanded. If you perform lengthy operations within this event, or firing this event multiple times somehow affects performance, we recommend you implement data caching.

Related GitHub Examples

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

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.

VB.NET

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

Private Sub gvMaster_MasterRowGetChildList(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs) Handles gvMaster.MasterRowGetChildList
    Dim relations As New List(Of RelationName)()

XPO_how-to-filter-an-associated-collection-in-legacy-xpo-versions-e876/VB/Form1.vb#L19

Private Sub gridView1_MasterRowGetChildList(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs) Handles gridView1.MasterRowGetChildList
    Dim masterGrid As GridView = TryCast(sender, GridView)

XPO_how-to-bind-a-non-persistent-collection-property-to-a-grid-control-e2062/VB/Form1.vb#L19

Private Sub gridView1_MasterRowGetChildList(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs) Handles gridView1.MasterRowGetChildList
    Dim masterGrid As GridView = TryCast(sender, GridView)

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

Private Sub gridView1_MasterRowGetChildList(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs) Handles gridView1.MasterRowGetChildList
    Dim c As Customers = CType(gridView1.GetRow(e.RowHandle), Customers)

how-to-display-additional-field-values-at-the-detail-level-e931/VB/Form1.vb#L142

Private Sub gridView1_MasterRowGetChildList(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventArgs) Handles gridView1.MasterRowGetChildList
    Dim clone As DataTable = customers.Clone()

C#

how-to-display-additional-field-values-at-the-detail-level-e931/CS/Form1.cs#L99

this.gridView1.MasterRowGetLevelDefaultView += new DevExpress.XtraGrid.Views.Grid.MasterRowGetLevelDefaultViewEventHandler(this.gridView1_MasterRowGetLevelDefaultView);
this.gridView1.MasterRowGetChildList += new DevExpress.XtraGrid.Views.Grid.MasterRowGetChildListEventHandler(this.gridView1_MasterRowGetChildList);
this.gridView1.MasterRowGetRelationCount += new DevExpress.XtraGrid.Views.Grid.MasterRowGetRelationCountEventHandler(this.gridView1_MasterRowGetRelationCount);