Frame.SaveModel() Method

Writes information on a Frame‘s View and Template to the Application Model.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public void SaveModel()

VB.NET

Public Sub SaveModel

Remarks

This method writes the current settings of the current Frame‘s Frame.View and Frame.Template (e.g. the settings of a Detail View’s items or a List View’s Grid Editor) to the corresponding Application Model nodes. Currently, this method is used in Windows Forms Applications when closing a Window. In ASP.NET Web Forms applications, end-users cannot customize UI elements.

Generally, you do not need to call this method. You can handle the Frame.ViewModelSaving and Frame.TemplateModelSaving events which are raised when synchronising information on the Frame’s View and Template, respectively.

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