IObjectSpace.SetModified(Object) Method

Sets the state of the specified object to Modified and adds this object to the track list of changes that should be committed.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

void SetModified(
    object obj
)

VB.NET

Sub SetModified(
    obj As Object
)

Parameters

Name	Type	Description
obj	Object	A persistent object whose IsModified state should be changed.

Remarks

If a data layer notification mechanism cannot track object changes, use the SetModified method. This method adds the object to the list of changes that should be committed.

In the BaseObjectSpace descendant, the BaseObjectSpace.SetModified method invokes the BaseObjectSpace.SetModified(Object obj, ObjectChangedEventArgs args) method. To change the object’s IsModified state, override the CreateObjectCore(Type type) method and return a new object of the type passed as the parameter.

You can raise the IObjectSpace.ObjectChanged event in your BaseObjectSpace.SetModified method override. The ObjectChanged event handler updates a Detail View’s Property Editor and a List View’s List Editor when their objects are changed.

The IObjectSpace.ModifiedObjects property contains objects in the Modified state.

The following example clears the Tasks collection of the Contact Detail View and marks the Contact object as modified:

C#

using System;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.ExpressApp.Editors;
using MySolution.Module.BusinessObjects;
//...
namespace MySolution.Module.Controllers {
    public class ClearEmployeeTasksController : ViewController {
        private SimpleAction ClearTasksAction;
        public ClearEmployeeTasksController() {
            ClearTasksAction = new SimpleAction();
            ClearTasksAction.Execute += new SimpleActionExecuteEventHandler(ClearTasksAction_Execute);
        }

        private void ClearTasksAction_Execute(Object sender, SimpleActionExecuteEventArgs e) {
            while(((Employee)View.CurrentObject).Tasks.Count > 0) {
                ((Employee)View.CurrentObject).Tasks.Remove(((Employee)View.CurrentObject).Tasks[0]);
            }
            ObjectSpace.SetModified(View.CurrentObject);
        }
    }
}

VB.NET

Imports System
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.ExpressApp.Editors
Imports MySolution.Module.BusinessObjects
'...
Namespace MySolution.Module.Controllers
    Public Class ClearEmployeeTasksController
        Inherits ViewController

        Private ClearTasksAction As SimpleAction
        Public Sub New()
            ClearTasksAction = New SimpleAction()
            AddHandler ClearTasksAction.Execute, AddressOf ClearTasksAction_Execute
        End Sub

        Private Sub ClearTasksAction_Execute(ByVal sender As Object, ByVal e As SimpleActionExecuteEventArgs)
            Do While DirectCast(View.CurrentObject, Employee).Tasks.Count > 0
                DirectCast(View.CurrentObject, Employee).Tasks.Remove(DirectCast(View.CurrentObject, Employee).Tasks(0))
            Loop
            ObjectSpace.SetModified(View.CurrentObject)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SetModified(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-how-to-display-a-collection-property-as-a-checked-list-box/CS/DXExample.Module.Win/WinCheckedListBoxPropertyEditor.cs#L51

    OnControlValueChanged();
    objectSpace.SetModified(CurrentObject);
}

VB.NET

xaf-how-to-display-a-collection-property-as-a-checked-list-box/VB/DXExample.Module.Win/WinCheckedListBoxPropertyEditor.vb#L53

    OnControlValueChanged()
    objectSpace.SetModified(CurrentObject)
End Sub