XafApplication.CreateCustomModelDifferenceStore Event

Occurs when a storage for model differences is being created.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<CreateCustomModelDifferenceStoreEventArgs> CreateCustomModelDifferenceStore

VB.NET

Public Event CreateCustomModelDifferenceStore As EventHandler(Of CreateCustomModelDifferenceStoreEventArgs)

Event Data

The CreateCustomModelDifferenceStore event's data class is CreateCustomModelDifferenceStoreEventArgs. The following properties provide information specific to this event:

Property	Description
Handled	Gets or sets a value that indicates whether the event handler has completely handled the event or whether the system should continue its own processing. Inherited from HandledEventArgs.
Store	Specifies a custom Application Model differences storage to be used by the application.

The event data class exposes the following methods:

Method	Description
AddExtraDiffStore(String, ModelStoreBase)	Adds extra model differences storage.

Remarks

The Application Model‘s base content formed from the code can be changed via the Model Editor. When the Application Model is loaded, the changes from the Model.xafml file are superimposed on the content generated previously. To load the changes saved to the Model.xafml file, a special storage is used. It finds this file near the executable file in the application project and load changes to the Application Model. For details, refer to the Model Difference Storages article.

If you need to store the Model.xafml file in a custom resource (e.g., in a Web service or register), implement your own storage by inheriting from the ModelDifferenceStore abstract class. To make the system use your storage, handle the CreateCustomModelDifferenceStore event and set it for the handler’s Store parameter. To prohibit the creation of the default storage object, set the handler’s Handled parameter to true.

Note

If you need to modify the mechanism of Application Model differences store in both an ASP.NET Web Forms and Windows Forms application, you need to use an individual handler in the ASP.NET Web Forms and Windows Forms application.

To see an example of using the CreateCustomModelDifferenceStore event, refer to the How to: Store the Application Model Differences in the Database topic. To use a custom storage for saving and loading an end-user’s Application Model changes, handle the XafApplication.CreateCustomUserModelDifferenceStore event.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateCustomModelDifferenceStore event.

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-show-filter-dialog-before-listview/CS/E1554.Module.Win/WinModule.cs#L25

application.ModelChanged += new EventHandler(application_ModelChanged);
application.CreateCustomModelDifferenceStore += Application_CreateCustomModelDifferenceStore;
application.CreateCustomUserModelDifferenceStore += Application_CreateCustomUserModelDifferenceStore;

VB.NET

XAF_how-to-show-filter-dialog-before-listview/VB/E1554.Module.Win/WinModule.vb#L27

AddHandler application.ModelChanged, AddressOf application_ModelChanged
AddHandler application.CreateCustomModelDifferenceStore, AddressOf Application_CreateCustomModelDifferenceStore
AddHandler application.CreateCustomUserModelDifferenceStore, AddressOf Application_CreateCustomUserModelDifferenceStore