Skip to main content
BuyLog In
XAF: Cross-Platform .NET App UI & Web API
Search in…
Docs > Storage, ORM, and Business Model Design > Business Model Design with Entity Framework 6 (Maintenance Mode) > How to: Use the Entity Framework 6 Data Model Located in an External Assembly
All docs
V21.2
.NET Framework 4.5.2+
Cross-Platform .NET App UI (XAF)
Getting Started
Installation, Upgrade, Version History
Application Shell and Base Infrastructure
Storage, ORM, and Business Model Design
Business Model Design with Entity Framework Core
Business Model Design with XPO
Non-Persistent Objects
The Importance of Property Change Notifications
Built-in Business Classes & Interfaces
Ways to Add a Business Class
Data Types Supported by built-in Editors
Mapping Complex Types to the Database
Types Info Subsystem
Connect an XAF Application to a Database Provider
Data Annotation Attributes
Create and Update the Application's Database
Business Model Design with Entity Framework 6 (Maintenance Mode)
Use the Entity Framework 6 Data Model
Relationships Between Entities in Code and UI
Model First Specifics
Use Entity Framework 6 with an Existing Database
How to: Initialize Business Objects with Default Property Values in Entity Framework 6
How to: Supply Initial Data for the Entity Framework 6 Data Model
How to: Use the Entity Framework 6 Code First in XAF
How to: Use the Entity Framework 6 Data Model Located in an External Assembly
How to: Use the Entity Framework 6 Model First in XAF
How to: Specify a Display Member for a Lookup Editor, Detail Form Caption, and more
How to: Use Both Entity Framework 6 and XPO in a Single Application
Data Manipulation and Business Logic
User Interface and Behavior Customization
Data Filtering
Data Security and Safety
Backend Web API Service (CTP)
Validation (Prevent Data Errors)
Conditional Appearance (Manage State of UI Elements)
Reporting (Shape, Export & Print Data)
Analytics (Extract Data Insights)
Document Management
Business Process Management
Event Planning
Localization
Debugging, Testing and Error Handling
Deployment
Support, QA & Troubleshooting
API Reference
Download CHM

How to: Use the Entity Framework 6 Data Model Located in an External Assembly

  • 3 minutes to read

If you have a non-XAF application, and want to develop an XAF application that utilizes the same database, you can generate business classes for an existing database to achieve this task. However, if your existing application is based on the Entity Framework 6 data model, you can reuse this model in XAF to avoid code duplication. This topic describes how to use the data model located within an external assembly.

Note

  • If the external assembly is an XAF Module, then you do not need to follow this topic. Entities declared within XAF modules are automatically recognized and added to the Application Model.

  • ASP.NET Core Blazor applications do not support the EF 6 business model.

  1. Create a new XAF solution using the DevExpress v21.2 XAF Template Gallery. Select Entity Framework 6 at the Choose ORM step and click Finish.
  2. Reference the external assembly that contains the Entity Framework 6 data model to be used.

  3. A DbContext class is required to use entities from the external assembly. To declare it, do one of the following.

    • In the module project, inherit the DbContext declared in the external assembly.
    • Add required entity types from the external assembly to the existing DbContext located in the BusinessObjects/MySolutionDbContext.cs(MySolutionDbContext.vb) file.

  4. Run the Module Designer. In the Exported Types section, expand the Referenced Assemblies node. Then, expand the node that corresponds to the external assembly. Select entities to add and press the SPACEBAR or use the Use Type in Application command from the context menu. The selected entities will be marked in bold. This means that they have been added to the Application Model, and will take part in the UI construction process.

    EF_ExternalAssembly_ModuleDesigner

    Note

    Alternatively, you can add entities in code. Open the Module.cs (Module.vb) file and add the required entity types to the ModuleBase.AdditionalExportedTypes collection in the module’s constructor.

  5. Rebuild your solution, so that the changes made in the Designer are loaded to the Application Model, and run the Model Editor. Make sure that the entities added in the previous step are available in the BOModel node.

    EF_ExternalAssembly_ModelEditor

  6. Add navigation items for the added entities by following the steps described in the Add an Item to the Navigation Control tutorial.

    EF_ExternalAssembly_Navigation

  7. Ensure that the correct DbContext type is passed to the application’s Object Space Provider in the CreateDefaultObjectSpaceProvider method located in WinApplication.cs (WinApplication.vb) and WebApplication.cs (WebApplication.vb) files. For details, refer to the Specify the Entity Container (Context) section of the Use the Entity Framework 6 Data Model topic.
See Also