SerializableObjectLayerClient.LoadCollectionObjectsAsync(Session, XPMemberInfo, Object, CancellationToken) Method

Performs object layer specific operations that are required to asynchronously load a collection property using specified settings.

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<object[]> LoadCollectionObjectsAsync(
    Session session,
    XPMemberInfo refProperty,
    object ownerObject,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function LoadCollectionObjectsAsync(
    session As Session,
    refProperty As XPMemberInfo,
    ownerObject As Object,
    cancellationToken As CancellationToken = Nothing
) As Task(Of Object())

Parameters

Name	Type	Description
session	Session	A Session that is used to asynchronously load collection objects.
refProperty	XPMemberInfo	The ownerObject‘s property that references a collection property.
ownerObject	Object	The object that owns the collection property.

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<Object[]>	A Task<TResult> that returns an array of collection objects.

Implements

LoadCollectionObjectsAsync(Session, XPMemberInfo, Object, CancellationToken)