DynamicCollection.FetchObjects Event

Occurs when the DynamicCollection contents are accessed for the first time, when this collection is reloaded, or its Criteria and Sorting parameters are changed. Handle this event and set the FetchObjectsEventArgs.Objects argument the DynamicCollection contents.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v20.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<FetchObjectsEventArgs> FetchObjects

VB.NET

Public Event FetchObjects As EventHandler(Of FetchObjectsEventArgs)

Event Data

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

Property	Description
Criteria	Specifies criteria used to filter objects in the Objects collection.
InTransaction	Specifies if the specified Criteria and Sorting parameters are applied to all objects (in the database and retrieved).
Objects	Objects that is the DynamicCollection contents. You can shape (filter, sort, or trim) this collection yourself or set the ShapeData parameter to true to make the DynamicCollection do this.
ObjectType	Returns the type of objects that can be contained by the Objects collection.
ShapeData	Specifies whether the DynamicCollection should shape (filter, sort) the Objects collection.
Sorting	Specifies the list of SortProperty objects that specify the sort order for the Objects collection.
TopReturnedObjects	Specifies the maximum number of objects DynamicCollection gets from the Objects collection.

Remarks

Refer to the Filter and Sort Non-Persistent Objects section to learn how to handle this event.

Related GitHub Examples

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

C#

XAF_Non-Persistent-Objects-Filtering-Demo/CS/NonPersistentObjectsDemo.Module/BusinessObjects/Contact.cs#L54

var collection = new DynamicCollection(objectSpace, e.ObjectType, e.Criteria, e.Sorting, e.InTransaction);
collection.FetchObjects += DynamicCollection_FetchObjects;
e.Objects = collection;

XAF_Non-Persistent-Objects-Editing-Demo/CS/NonPersistentObjectsDemo.Module/TransientNonPersistentObjectAdapter.cs#L89

var collection = new DynamicCollection(objectSpace, e.ObjectType, e.Criteria, e.Sorting, e.InTransaction);
collection.FetchObjects += DynamicCollection_FetchObjects;
e.Objects = collection;

VB.NET

XAF_Non-Persistent-Objects-Filtering-Demo/VB/NonPersistentObjectsDemo.Module/BusinessObjects/Contact.vb#L73

Dim collection = New DynamicCollection(objectSpace, e.ObjectType, e.Criteria, e.Sorting, e.InTransaction)
AddHandler collection.FetchObjects, AddressOf DynamicCollection_FetchObjects
e.Objects = collection

XAF_Non-Persistent-Objects-Editing-Demo/VB/NonPersistentObjectsDemo.Module/TransientNonPersistentObjectAdapter.vb#L86

Dim collection = New DynamicCollection(objectSpace, e.ObjectType, e.Criteria, e.Sorting, e.InTransaction)
AddHandler collection.FetchObjects, AddressOf DynamicCollection_FetchObjects
e.Objects = collection