XafApplication.SaveModelChanges() Method

Saves the changes made by an end-user, up to the current moment, to the differences storage.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public virtual void SaveModelChanges()

VB.NET

Public Overridable Sub SaveModelChanges

Remarks

By default, this method is called when the application is closed. So, all the changes made from the application start until the end are saved to the Model.User.xafml file. You can call this method at any time during the application run. For instance, you can implement an Action that allows end-users to save the changes made, up to the current moment.

Note

Since end-user changes are only saved in Windows Forms applications, do not use this method in ASP.NET Web Forms applications.

You can save user changes to another storage; for example, to the database. For this purpose, handle the XafApplication.CreateCustomUserModelDifferenceStore event.

Example

The code below saves the current application state:

File:
MySolution.Win/Controllers/MyController.cs in solutions without the WinForms-specific module project. MySolution.Module.Win/Controllers/MyController.cs(.vb) in solutions with the WinForms-specific module project.

C#

using DevExpress.ExpressApp.Win;
// ...
public class MyController : ViewController //or WindowController
// ...
    private void action_Execute(object sender, SimpleActionExecuteEventArgs e) {
        // Save Model settings in all opened windows in a WinForms application.
        foreach(Frame frame in ((WinShowViewStrategyBase)Application.ShowViewStrategy).Windows) {
            frame.SaveModel();
            // OR
            // frame.View.SaveModel();
        }

        // OR
        // Save Model settings only in the main application window.
        // Application.MainWindow.SaveModel();

        // Save the latest Model settings to a Model difference storage.
        Application.SaveModelChanges();
    }
// ...
}

VB.NET

Imports DevExpress.ExpressApp.Win
' ...
Public class MyController : ViewController 'or WindowController 
' ...
    Private Sub action_Execute(ByVal sender As Object, ByVal e As SimpleActionExecuteEventArgs)
        ' Save Model settings in all opened windows in a WinForms application.
        For Each frame As Frame In (CType(Application.ShowViewStrategy, WinShowViewStrategyBase)).Windows
            frame.SaveModel()
            ' OR
            ' frame.View.SaveModel()
        Next
        ' OR
        ' Save Model settings only in the main application window.
        ' Application.MainWindow.SaveModel()

        ' Save the latest Model settings to a Model difference storage.
        Application.SaveModelChanges()
    End Sub   
' ...
End Class