Skip to content

Entity Framework visual design surface and code-first code generation for EF6, Core and beyond

License

Notifications You must be signed in to change notification settings

Muhendiz/EFDesigner

 
 

Repository files navigation

Entity Framework Designer

Entity Framework visual design surface and code-first code generation for EF6, EFCore and beyond.

Model and generate code for Entity Framework v6, Entity Framework Core 2.0 and 2.1

Install with NuGet from the Visual Studio Marketplace

Complete documentation in the project's documentation site

This Visual Studio 2017 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 changes you make to your generated code are 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:

  • the ability to show and hide parts of the model
  • easy customization of generated output
  • class and enumeration nodes that can be colored to visually group the model
  • different concerns being generated into different subdirectories (entities, enums, dbcontext)
  • entities by default generated as partial classes so the default code can be easily modified
  • string length, index flags, required attributes and other properties being available in the designer

and many other nice-to-have bits.

Code generation is completely customizable via T4 templates. The tool installs templates that target both EF6 and EFCore, and generate both a code-first DbContext class and POCO entity classes. The EF6 template's DbContext code is written to allow consumption in ASP.Net Core in addition to any other project type, so you'll have flexibility in your development.

You can read more about how to use the designer in the Documentation site.

Change Log

1.2.6.12

  • 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)
  • 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)
  • Added compartment for association sources so Bidirectional associations would show up

1.2.6.11

  • 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.
1.2.6.7
  • An entity's concurrency token property is no longer a required parameter in its constructor (msawczyn#24)
  • Simplified cascade delete settings in property editor for associations
  • Fixed bad code generation in EFCore for cascade delete overrides (msawczyn#22)
  • Missing files when generating code for .NET Core projects fixed
  • Tightened up and swatted some bugs in INotifyPropertyChanged handling. Added documentation to doc site for this feature (following up on msawczyn#23)
  • Ensured multiline editing was available in property window for those properties that made sense
1.2.6.6
  • [NEW] Deleting a generalization or superclass gives the choice of pushing attributes and associations down to the former child class(es)
1.2.6.5
  • 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 < 1.2.6.3
  • Support for automatic migration to new model xml formats
1.2.6.2
  • 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
1.2.5.1
1.2.5.0
1.2.4.0
  • 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
1.2.3.3
  • 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.
1.2.3.0
1.2.2.0
  • 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
1.2.1.0
  • 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
1.2.0.0
  • 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
  • Enhancements
    • 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
1.1.0.0
  • 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
1.0.3.9
  • 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
1.0.3.8
  • Fixed project item placement
  • Added change checks to diagram so dirty flag doesn't set when nothing changes
1.0.3.7
  • Emergency bug fixes
1.0.3.6
  • 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)
1.0.3.5
  • Enhanced portability between EF6 an EFCore
1.0.3.4
  • 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.
1.0.3.3
  • Fix to spurious error when copying/pasting model elements
  • Do not use this release. Fix didn't extend to enum elements. This is fixed in 1.0.3.4.
1.0.3.2
  • Minor bug fix in parsing manually typed attributes.
  • Loosened model file version check to only check major version.
1.0.3.0
  • Enhanced syntax for adding/editing attributes via code
  • Fix for generate-on-save for both Framework and .NET Core projects.
1.0.2.0
  • [NEW] EFCore T4 template now available
1.0.1.0
  • Fix to EF6 T4 for issue where column names in many-to-many association join tables were flipped
1.0.0.0
  • Initial release

About

Entity Framework visual design surface and code-first code generation for EF6, Core and beyond

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 99.5%
  • Other 0.5%