This Visual Studio 2017/2019 extension adds a new file type (.efmodel) that allows for fast, easy and, most importantly, visual design
of persistent classes. Inheritance, unidirectional and bidirectional associations are all supported. Enumerations are also included in
the visual model, as is the ability to add text blocks to explain potentially arcane parts of your design.
While giving you complete control over how the code is generated you'll be able to, out of the box, create sophisticated,
consistent and correct Entity Framework code that can be regenerated when your model changes. And, since the code is written using
partial classes, any additions you make to your generated code is retained across subsequent generations.
If you are used to the EF visual modeling that comes with Visual Studio, you'll be pretty much at home. The goal was to duplicate
at least those features and, in addition, add all the little things that should have been there. Things like:
- importing entities from C# source, or existing DbContext definitions (including their entities) from compiled EF6 or EFCore assemblies
- the ability to show and hide parts of the model
- easy customization of generated output by editing or even replacing the T4 templates
- entities by default generated as partial classes so the generated code can be easily extended
- class and enumeration nodes that can be colored to visually group the model
- different concerns being generated into different subdirectories (entities, enums, dbcontext)
- string length, index flags, required attributes and other properties being available in the designer
and many other nice-to-have bits.
For comprehensive documentation, please visit the project's documentation site.
In Visual Studio 2019, projects using the new project format (typically .NET Core and .NET Standard projects) will throw an exception when
opening an .efmodel file. This is an issue related to the Visual Studio 16 SDK and is currently under investigation. Visual Studio
2017 does not exhibit this issue.
If this is important to you, you can follow it at developercommunity.visualstudio.com.
- Fixed error found in some VS2017 installations preventing running due to dependency problems
- Enhanced source code drag/drop to handle bidirectional associations and enumerations better.
- [NEW] Can now import assemblies containing DbContext classes. Dropping a compiled assembly onto the design surface will attempt to process and merge it into the design.
- [NEW] Added ability to merge two unidirectional associations into one bidirectional association (via context menu action)
- [NEW] Added ability to split a bidirectional association to two unidirectional associations (via context menu action)
- [NEW] Added Microsoft Automatic Graph Layout, giving the user the ability to choose the diagram's auto-layout strategy
- [NEW] Added additional types of UInt16, UInt32, UInt64 and SByte to property type list
- [NEW] Added the ability to use a modeled enumeration, if it has a proper backing type, as an entity identifier
- [NEW] Added DateTime.UtcNow as a valid initial value for a DateTime property
- Fix for "One-to-one relation in EFCore" (See https://github.com/msawczyn/EFDesigner/issues/71)
- Remove default DbContext constructor in EFCore to allow support for AddDbContextPool calls in ConfigureServices (See https://github.com/msawczyn/EFDesigner/issues/72)
- Fix for duplicate associations when
Implement Notify is true
- Fix for join table schema generation in certain scenarios (EF6)
- Fix for regression error producing code gen errors in EFCore navigation properties
- Fix for designer item not showing in Add Items dialog
- [NEW] Added code in EF6 templates to generate orphan cleanup (experimental)
- Fix for 1..1 and 0-1..0-1 associations in EF Core generated code
- Entity constructor parameters normalized to help in JSON serialization/deserialization
- Generation of column type overrides now generates valid override code in OnModelCreating
- DbSet properties in DbContext generate as virtual to facilitate mocking
- Bugfix to remove unnecessary permission requests to push attributes down when deleting leaf nodes in an inheritance tree
- Fix to workaround Visual Studio pulling in the wrong System.Net.Http reference. (See https://developercommunity.visualstudio.com/content/problem/296293/vs2017-1575-ignores-the-hintpath-and-take-the-syst.html)
- [NEW] Add EFModel.xsd to Visual Studio schema cache in order to avoid editor warnings for missing schema
- Fixed template issue for non-English-language systems (where Microsoft Pluralization Service is unavailable)
- [NEW] Added compartment for association sources so Bidirectional associations would show up
- Tweak to force association end roles to be correct when roles or multiplicities change
- Attribute elements' "String Properties" don't appear unless the attribute is a string
- Attribute elements' "Indexed Unique" property doesn't appear unless the attribute has "Indexed" equal to "True"
- Fixed background color on attribute glyph in model explorer
- Fixed foreground color on enum value glyph on design surface
- Hid comments in model explorer because they just cluttered up the tree.
- [NEW] Associations now show up in their own compartment in a class on the design surface. Note that this changes the height of your elements, so the first time opening a model you may have to tweak your esthetics a bit.
- [NEW] Double-clicking a class or enum on the designer opens the generated code file, if it exists. If it doesn't exist, you're asked if you'd like to generate the model then, if you do, it tries again.
- Known issue: EFCore/.NETCore and EFCore/.NETFramework projects won't ask to generate the code if they can't open the file; they just fail silently. All other EF/.NET combinations behave appropriately.
- [NEW] Deleting a generalization or superclass gives the choice of pushing attributes and associations down to the former child class(es)
- Comment elements now wrap the text
- Multiline editor available in property window for element comment descriptions and Comment element text
- Xml format changed for .efmodel file - can't be loaded by any version < 18.104.22.168
- Support for automatic migration to new model xml formats
- Added XML docs to DbContext, DatabaseInitializer and DbMigrationsConfiguration
- [NEW] Enabled drag and drop reordering of enum values and class properties
- Gave some color to the enum value glyph in the model explorer - it was so boring!
- [NEW] Class properties and enum values with warnings now show a warning icon on the design surface
- [NEW] Design surface has a property to turn on or off the display of the warning icons
- Recategorized a few "Misc" properties on the design surface
- Retargeted immediate error and warning messages to Visual Studio output window rather than error window so they could be cleared
- Added drag validation to Generalization (inheritance) tool
- Automatically propagate enum name and value name changes to classes that use them
- Reverted the selection of the node in the model explorer when an element is selected in the diagram. Was causing bad user experience.
- Fix for bad code generation when a class has multiple properties that each have an darabase index specified.
- Fix issue with association role end changing without the other side autoatically changing
- Fix issue with deleting a highlighted element throwing an error when trying to save the file
- Fixed code generation for dependent classes
- [NEW] Designer now automatically saves before generating code
- Bug fix for inheritance strategy automatically changing to table-per-hierarchy if targeting EF Core
- Updated a few warning and error messages to make them more meaningful
- Fixes for how dependent types work
- Remove stale error and warnings prior to save (still a few left hanging around that need looked at)
- Fixed a few null reference errors
- New Features
- Roslyn-based code analysis now allows dragging C# files onto the design surface to add or update classes and enums
- Can add
INotifyPropertyChanged interface and implementation for entities
- Ability to tag model as a specific EF version (especially useful for EF Core as new capabilities are being added often)
- Support for dependent (complex/owned) types
- Option to generate dependent types in a separate directory
- Output directory overrides for classes and enums
- On model save, can optionally automatically install EF NuGet packages for the model's EF type and version
- Context menu action to expand and collapse selected classes and enums
- Added ability to add/edit enum values via text in the same way properties can be added/edited in classes
- Property grid hides element properties if they're not appropriate for the EF version
- Inheritance strategy automatically changes to table-per-hierarchy if targeting EF Core
- Context property
Database Type changed to
SqlServer Type to better reflect what it does
- Selecting an element in the Model Explorer highlights it on the diagram
- Bug fixes for exceptions thrown when bad input to model attributes as text
- [NEW] Added MinLength string property (used in EF6 only as of this writing)
- Modified attribute parser to accept MinLength
- [NEW] Added ColumnName property to model attribute
- [NEW] Added MEF extension capability
- Added some unit tests
- Added some documentation updates
- Changed version to 1.1.0 due to MEF capability
- If no entities and model is using an unsupported inheritance strategy,
changing from EF6 to EFCore doesn't give a message, just changes the strategy.
- [NEW] Added IsFlags attribute (and matching validations and behavior) to Enums
- NGENed extension assembly
- Fixed project item placement
- Added change checks to diagram so dirty flag doesn't set when nothing changes
- Fixed parser errors when editing model attributes as text
- Fixed error when auto-generating on save and design surface is not the active window
- Fixed crash when used on non-English-language systems (where Microsoft Pluralization Service is unavailable)
- [NEW] Added option to generate warnings if no documentation
- Standardized warning and error message structure
- Added ability to choose 'None' DatabaseInitializer type; generates SetInitializer(null)
- Enhanced portability between EF6 an EFCore
- Adds some T4 fixes to make generated code more usable in ASP.NET Core applications.
- Fix to spurious error when copying/pasting enum elements.
- [NEW] First release that's available on Visual Studio Marketplace.