Session.GetObjectsToDelete() Method

Returns a collection of persistent objects that will be deleted when the current transaction is committed.

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 ICollection GetObjectsToDelete()

VB.NET

Public Function GetObjectsToDelete As ICollection

Returns

Type	Description
ICollection	The collection of persistent objects that when the current transaction is committed.

Remarks

For general information on deleting persistent objects, see Deleting Persistent Objects.

Objects that have Deferred Deletion enabled are actually modified upon deletion. So, they appear in the collection returned by the Session.GetObjectsToSave method, not in the collection returned by the Session.GetObjectsToDelete method.

The Session.GetObjectsToSave and Session.GetObjectsToDelete methods do not create new collection instances and fill them with objects when called. Instead, these methods return references to internal collections whose content changes throughout the life cycle of a Session.

C#

ICollection changedObjects = myUnitOfWork.GetObjectsToSave();
int count = changedObject.Count; // 'count' is an arbitrary number
myUnitOfWork.CommitChanges();
count = changedObject.Count; // here, 'count' always equals zero

VB.NET

Dim changedObjects As ICollection = myUnitOfWork.GetObjectsToSave()
Dim count As Integer = changedObject.Count ' 'count' is an arbitrary number
myUnitOfWork.CommitChanges()
count = changedObject.Count ' here, 'count' always equals zero