Session.GetObjectsAsync(XPClassInfo, CriteriaOperator, SortingCollection, Int32, Boolean, Boolean, AsyncLoadObjectsCallback) Method

Asynchronously gets a collection of persistent objects that match the specified criteria and notifies upon completion.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public object GetObjectsAsync(
    XPClassInfo classInfo,
    CriteriaOperator criteria,
    SortingCollection sorting,
    int topSelectedRecords,
    bool selectDeleted,
    bool force,
    AsyncLoadObjectsCallback callback
)

VB.NET

Public Function GetObjectsAsync(
    classInfo As XPClassInfo,
    criteria As CriteriaOperator,
    sorting As SortingCollection,
    topSelectedRecords As Integer,
    selectDeleted As Boolean,
    force As Boolean,
    callback As AsyncLoadObjectsCallback
) As Object

Parameters

Name	Type	Description
classInfo	XPClassInfo	An XPClassInfo object that provides metadata information on the persistent objects to be returned.
criteria	CriteriaOperator	A CriteriaOperator descendant which represents the search criteria.
sorting	SortingCollection	A SortingCollection object which represents a collection of SortProperty objects.
topSelectedRecords	Int32	An integer value which specifies the maximum number of returned objects.
selectDeleted	Boolean	true to include the persistent objects marked as deleted into the collection; otherwise, false.
force	Boolean	true to reload the objects from a data store; otherwise, false.
callback	DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback	A DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback delegate to be called after the collection has been retrieved. This collection is passed as a parameter to callback.

Returns

Type	Description
Object	An object identifying the current asynchronous operation, intended for internal use.

Remarks

This member supports the internal infrastructure and is not intended to be used directly from your code. To asynchronously get objects from a session, call the LoadAsync method of the XPCollection or XPView component.