Session.ReloadAsync(Object, Boolean, CancellationToken) Method

Recursively reloads a persistent object’s state and aggregated objects from the data store, asynchronously.

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 ReloadAsync(
    object theObject,
    bool forceAggregatesReload,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function ReloadAsync(
    theObject As Object,
    forceAggregatesReload As Boolean,
    cancellationToken As CancellationToken = Nothing
) As Task

Parameters

Name	Type	Description
theObject	Object	An object which represents the persistent object whose state needs to be reloaded.
forceAggregatesReload	Boolean	true, to recursively reload the state of aggregated objects; otherwise, false.

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 reloads a persistent object’s state and aggregated objects from the data store.

Remarks

To start a transaction, use the Session.BeginTransaction method. To commit all data modifications made since the start of the transaction and complete the transaction, call the ReloadAsync or Session.CommitTransaction method. To discard these modifications, call the Session.RollbackTransaction method.

To determine if a transaction is in progress, use the Session.InTransaction property.

After the ReloadAsync method is called, the Session.BeforeCommitTransaction event is raised.

Note

In a NestedUnitOfWork, calling the ReloadAsync method throws the System.NotSupportedException, since changes within these Units should be saved using only the main thread.