XPBaseCollection.BaseRemoveAsync(Object, CancellationToken) Method

Asynchronously removes the specified persistent object from the XPBaseCollection.

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

VB.NET

Public Function BaseRemoveAsync(
    theObject As Object,
    cancellationToken As CancellationToken = Nothing
) As Task(Of Boolean)

Parameters

Name	Type	Description
theObject	Object	An object to remove from the collection.

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<Boolean>	A Task<TResult> that returns true if the object has been successfully removed from the collection; otherwise, false.