XPBaseCollection.LoadAsync(CancellationToken) Method

Asynchronously loads persistent objects of a specific type from the data store into the collection.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v23.2.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

public virtual Task LoadAsync(
    CancellationToken cancellationToken
)

VB.NET

Public Overridable Function LoadAsync(
    cancellationToken As CancellationToken
) As Task

Parameters

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

Returns

Type	Description
Task	A Task that starts the collection load.

Remarks

Note

If the XPBaseCollection.LoadingEnabled property is set to false, calling the LoadAsync method has no effect.

The following example demonstrates how to asynchronously work with persistent objects.

C#

using DevExpress.Xpo;
// ...
XPCollection<Customer> customers = new XPCollection<Customer>(session);
await customers.LoadAsync();
gridControl.DataSource = customers;

VB.NET

Imports DevExpress.Xpo
' ...
Dim customers As New XPCollection(Of Customer)(session)
Await customers.LoadAsync()
gridControl.DataSource = customers