Session.BulkLoadAsync(CancellationToken, IXPBulkLoadableCollection[]) Method

Asynchronously retrieves persistent objects to populate specified IXPBulkLoadableCollection type collections.

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 Task BulkLoadAsync(
    CancellationToken cancellationToken = default(CancellationToken),
    params IXPBulkLoadableCollection[] collections
)

VB.NET

Public Function BulkLoadAsync(
    cancellationToken As CancellationToken = Nothing,
    ParamArray collections As IXPBulkLoadableCollection()
) As Task

Parameters

Name	Type	Description
collections	DevExpress.Xpo.Helpers.IXPBulkLoadableCollection[]	An array of empty IXPBulkLoadableCollection type collections that receive persistent objects from a data store.

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Type	Description
Task	A Task that populates specified collections.

Remarks

The result is the same as calling the XPBaseCollection.Load method for each collection individually. This method simplifies loading multiple collections when lazy loading is not appropriate.