View.SaveModel() Method

Writes information on a View to the Application Model.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public void SaveModel()

VB.NET

Public Sub SaveModel

Remarks

Use this method to save the current settings of a View’s editor(s) to the Application Model node specified by the View’s View.Model property. These settings include those that correspond to properties of the Views | DetailView | Items and Views | DetailView | Layout or, Views | ListView, and Views | ListView | Columns nodes.

By default, this method is automatically called to save the current properties of a View’s editor(s) before assigning a new value to the View.Model property.

Handle the View.ModelSaving event to cancel saving information on a View’s editors to the Application Model.

Handle the View.CustomModelSaving event to perform a custom technique for saving the information.

Handle the View.ModelSaved event to save custom information on a View to the Application Model before it is updated.

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.View.SaveModel();
            // OR
            // frame.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

Related GitHub Examples

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

isLayoutProcessed = true;
View.SaveModel();
isLayoutProcessed = false;

VB.NET

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

isLayoutProcessed = True
View.SaveModel()
isLayoutProcessed = False