XPBaseCollection.LoadAsync(AsyncLoadObjectsCallback) Method

Asynchronously loads persistent objects of a specific type from the data store into the collection, 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 virtual bool LoadAsync(
    AsyncLoadObjectsCallback callback
)

VB.NET

Public Overridable Function LoadAsync(
    callback As AsyncLoadObjectsCallback
) As Boolean

Parameters

Name	Type	Description
callback	DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback	A DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback delegate to be called after loading is complete. Use callback to do the following: Iterate a collection of loaded persistent objects passed as a parameter, or store it for later use within the original thread. Store the exception information passed as a parameter, and use this information later to raise the exception again, within the original thread. Do not raise exceptions or modify persistent objects within a callback.

Returns

Type	Description
Boolean	true if the current method call started the collection load; otherwise, false.

Remarks

To reload data from a data store to the collection, call the XPBaseCollection.Reload method.

We recommend using the LoadAsync(CancellationToken) Task-based overload instead of this method.

Note

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

Example

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

In this example, a collection (xpcPersons) of Person objects is used as a data source for a grid control (gridPersons). The Update and Commit buttons (btnUpdate and btnCommit) allow users to update the grid control and store changes to a data store while continuing to interact with other UI elements. The accessibility of the grid control and these buttons is automatically updated within operation callbacks (CallBackLoadPersons and CallBackCommitChanges).

C#

using DevExpress.Xpo;
using DevExpress.Xpo.DB;

namespace AsyncOperations {

    // A custom XPObject
    class Person : XPObject {
       //...
    }

    public class AsyncLoading {
        UnitOfWork unitOfWork;
        // Initialize unitOfWork here.
        //...

        // An XPCollection to be used as a data source for the gridPersons grid control
        XPCollection xpcPersons;

        //...

        // The Click event handler of the Update button
        private void btnUpdate_Click(object sender, EventArgs e) {
            if (xpcPersons == null) {
                xpcPersons = new XPCollection(unitOfWork, typeof(Person));
                LoadAsyncPersons();
                gridPersons.DataSource = xpcPersons;
            } else {
                LoadAsyncPersons();
            }
        }

        // Disables buttons and the grid control and initiates asynchronous collection loading
        void LoadAsyncPersons() {
            btnUpdate.Enabled = false;
            btnCommit.Enabled = false;
            gridPersons.Enabled = false;
            xpcPersons.LoadAsync(new DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback(
                CallBackLoadPersons));
        }
        // Called after collection loading is complete
        // Re-enables buttons and the grid control
        void CallBackLoadPersons(ICollection[] result, Exception ex) {
            btnUpdate.Enabled = true;
            btnCommit.Enabled = true;
            gridPersons.Enabled = true;
            if (ex != null) {
                MessageBox.Show(ex.Message);
            }
        }

        // The Click event handler of the Commit button
        // Disables buttons and the grid control and asynchronously commits changes
        private void btnCommit_Click(object sender, EventArgs e) {
            btnUpdate.Enabled = false;
            btnCommit.Enabled = false;
            gridPersons.Enabled = false;
            unitOfWork.CommitChangesAsync(new AsyncCommitCallback(CallBackCommitChanges));
        }

        // Called after changes have been saved
        // Re-enables buttons and the grid control
        void CallBackCommitChanges(Exception ex) {
            btnUpdate.Enabled = true;
            btnCommit.Enabled = true;
            gridPersons.Enabled = true;
            if (ex != null) {
                MessageBox.Show(ex.Message);
            }
        }
    }
}

VB.NET

Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB

Namespace AsyncOperations

    ' A custom XPObject
    Friend Class Person
        Inherits XPObject
       '...
    End Class

    Public Class AsyncLoading
        Private unitOfWork As UnitOfWork
        ' Initialize unitOfWork here.
        '...

        ' An XPCollection to be used as a data source for the gridPersons grid control
        Private xpcPersons As XPCollection

        '...

        ' The Click event handler of the Update button
        Private Sub btnUpdate_Click(ByVal sender As Object, ByVal e As EventArgs)
            If xpcPersons Is Nothing Then
                xpcPersons = New XPCollection(unitOfWork, GetType(Person))
                LoadAsyncPersons()
                gridPersons.DataSource = xpcPersons
            Else
                LoadAsyncPersons()
            End If
        End Sub

        ' Disables buttons and the grid control and initiates asynchronous collection loading
        Private Sub LoadAsyncPersons()
            btnUpdate.Enabled = False
            btnCommit.Enabled = False
            gridPersons.Enabled = False
            xpcPersons.LoadAsync(New DevExpress.Xpo.Helpers.AsyncLoadObjectsCallback( _
                                                AddressOf CallBackLoadPersons))
        End Sub
        ' Called after collection loading is complete
        ' Re-enables buttons and the grid control
        Private Sub CallBackLoadPersons(ByVal result() As ICollection, ByVal ex As Exception)
            btnUpdate.Enabled = True
            btnCommit.Enabled = True
            gridPersons.Enabled = True
            If ex IsNot Nothing Then
                MessageBox.Show(ex.Message)
            End If
        End Sub

        ' The Click event handler of the Commit button
        ' Disables buttons and the grid control and asynchronously commits changes
        Private Sub btnCommit_Click(ByVal sender As Object, ByVal e As EventArgs)
            btnUpdate.Enabled = False
            btnCommit.Enabled = False
            gridPersons.Enabled = False
            unitOfWork.CommitChangesAsync(New AsyncCommitCallback(AddressOf CallBackCommitChanges))
        End Sub

        ' Called after changes have been saved
        ' Re-enables buttons and the grid control
        Private Sub CallBackCommitChanges(ByVal ex As Exception)
            btnUpdate.Enabled = True
            btnCommit.Enabled = True
            gridPersons.Enabled = True
            If ex IsNot Nothing Then
                MessageBox.Show(ex.Message)
            End If
        End Sub
    End Class
End Namespace