Session.Delete(Object) Method

Deletes the specified persistent object and its aggregated objects from persistent storage.

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 void Delete(
    object theObject
)

VB.NET

Public Sub Delete(
    theObject As Object
)

Parameters

Name	Type	Description
theObject	Object	An object which represents the persistent object to delete.

Remarks

Below is an example of using the Delete method. Here, session is the Session instance.

C#

Person personToDelete = session.GetObjectByKey<Person>(152);
session.Delete(personToDelete);

VB.NET

Dim personToDelete As Person = session.GetObjectByKey(Of Person)(152)
session.Delete(personToDelete)

If a persistent object has the DeferredDeletionAttribute, the Delete method doesn’t actually remove the underlying database record. Instead, it marks the record as deleted and writes a reference to this object for later use by the Session.PurgeDeletedObjects method. You should clear all references to the object to be deleted. Otherwise, the object will not be purged. To persist the deleted state, save the object by calling its XPBaseObject.Save method.

If the DeferredDeletionAttribute isn’t specified, the Delete method removes the underlying database record which corresponds to the persistent object unless there are references to this object.

Note

When an object with Deferred Deletion enabled is deleted, it is removed from associated collections. Associations cannot be recreated automatically when you restore a deleted object. This behavior is by design, because the Deferred Deletion feature is not intended for object restoration, but for overcoming complex foreign index constraints at the database level.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Delete(Object) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-data-grid-implement-crud-operations/CS/CodeBehind/XPO/LocalData/MainWindow.xaml.cs#L28

var row = (User)e.Rows.Single();
_UnitOfWork.Delete(row);
_UnitOfWork.CommitChanges();

reporting-mvc-db-storage/CS/DXWebApplication_ReportDesigner/Controllers/DesignerController.cs#L36

var report = session.GetObjectByKey<ReportEntity>(url);
session.Delete(report);

XPO_how-to-implement-odata4-service-with-xpo/CS/ODataService/Helpers/ApiHelper.cs#L31

}
uow.Delete(existing);
uow.CommitChanges();

XPO_how-to-generate-a-sequential-number-for-a-business-object-within-a-database-transaction-e2620/CS/ExplicitUnitOfWorkDemo/frmMain.cs#L35

//Delete the Address object.
explicitUnitOfWork.Delete(address);
//Save changes to the database in case of an explicit transaction.

VB.NET

reporting-mvc-db-storage/VB/DXWebApplication_ReportDesigner/Controllers/DesignerController.vb#L31

Dim report = session.GetObjectByKey(Of ReportEntity)(url)
session.Delete(report)

XPO_how-to-generate-a-sequential-number-for-a-business-object-within-a-database-transaction-e2620/VB/ExplicitUnitOfWorkDemo/frmMain.vb#L40

'Delete the Address object.
explicitUnitOfWork.Delete(address)
'Save changes to the database in case of an explicit transaction.