IObjectSpace.Delete(Object) Method

Marks the specified persistent object and its aggregated objects as deleted from a persistent storage.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

void Delete(
    object obj
)

VB.NET

Sub Delete(
    obj As Object
)

Parameters

Name	Type	Description
obj	Object	An object which is the persistent object to be deleted.

Remarks

Use this method to delete the object specified as the parameter from the database. Note, that the object is not deleted immediately. It is only marked as an object to be deleted during the next call of the IObjectSpace.CommitChanges method.

In the BaseObjectSpace class’s descendant, the Delete method is implemented. In this method, the IObjectSpace.CustomDeleteObjects event is raised, a protected virtual BaseObjectSpace.DeleteCore method is invoked and then the current Object Space is set as modified. Override the BaseObjectSpace.DeleteCore method to delete the specified object using the container for in-memory objects (for example, XPObjectSpace.Session in the case of an XPObjectSpace or EFCoreObjectSpace.DbContext in the case of an EFCoreObjectSpace).

After this method call, the Object Space’s IObjectSpace.IsModified property is set to true.

The following Controller contains the Action that deletes completed tasks:

File: MySolution.Module\Controllers\TaskViewController.cs(.vb).

C#

using DevExpress.ExpressApp;
using DevExpress.Persistent.BaseImpl;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
using DevExpress.Data.Filtering;
using DevExpress.Persistent.Base.General;
using System.Collections.Generic;
// ...
public class TaskViewController : ObjectViewController<ListView, Task> {
    public TaskViewController() {
        SimpleAction deleteCompletedTasksAction = 
            new SimpleAction(this, "Delete completed tasks", PredefinedCategory.Edit);
        deleteCompletedTasksAction.Execute += DeleteCompletedTasksAction_Execute;
    }
    private void DeleteCompletedTasksAction_Execute(object sender, SimpleActionExecuteEventArgs e) {
        CriteriaOperator completedTasksCriteria = 
            CriteriaOperator.FromLambda<Task>(t => t.Status == TaskStatus.Completed);
        IList<Task> completedTasks = ObjectSpace.GetObjects<Task>(completedTasksCriteria);
        ObjectSpace.Delete(completedTasks);
        ObjectSpace.CommitChanges();
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.Persistent.BaseImpl
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.Persistent.Base
Imports DevExpress.Data.Filtering
Imports DevExpress.Persistent.Base.General
Imports System.Collections.Generic
' ...
Public Class TaskViewController
    Inherits ObjectViewController(Of ListView, Task)
    Public Sub New()
        Dim deleteCompletedTasksAction As New SimpleAction(Me, "Delete completed tasks", PredefinedCategory.Edit)
        AddHandler deleteCompletedTasksAction.Execute, AddressOf DeleteCompletedTasksAction_Execute
    End Sub
    Private Sub DeleteCompletedTasksAction_Execute(ByVal sender As Object, ByVal e As SimpleActionExecuteEventArgs)
        Dim completedTasksCriteria As CriteriaOperator =
            CriteriaOperator.FromLambda(Of Task)(Function(t) t.Status = TaskStatus.Completed)
        Dim completedTasks As IList(Of Task) = ObjectSpace.GetObjects(Of Task)(completedTasksCriteria)
        ObjectSpace.Delete(completedTasks)
        ObjectSpace.CommitChanges()
    End Sub
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#

xaf-save-and-share-custom-view-settings/CS/ViewSettingsSolution.Module/Controllers/ViewVariantsController.cs#L82

IObjectSpace os = currentLayoutItem.ObjectSpace;
os.Delete(currentLayoutItem);
os.CommitChanges();

VB.NET

xaf-save-and-share-custom-view-settings/VB/ViewSettingsSolution.Module/Controllers/ViewVariantsController.vb#L102

Dim os As IObjectSpace = currentLayoutItem.ObjectSpace
os.Delete(currentLayoutItem)
os.CommitChanges()