Code templates documentation

Discussion of open issues, suggestions and bugs regarding Entity Developer - ORM modeling and code generation tool
Post Reply
dambsst
Posts: 6
Joined: Sun 29 Jan 2017 15:10

Code templates documentation

Post by dambsst » Fri 02 Jun 2017 17:41

Hello,

I do not find the documentation for many members and parameters of the language template. The tooltips hints and intellisense are working but there is no information showing up.

As example, how do you use output.Indent , output.IndentLiteral or output.IndentLength ?

But the most important for me is to find out where to look for the documentation related to EntityRelationProperty, EntityAssociation, etc...

Is there another documentation system? or is it based on sth else like T4 or xml so that I should look inside these documentation instead?

I have purchased entity developer but I don't see any extra documentation for registered user.

Please tell me where I can find the complete documentation.

Many thanks,

Damien

Shalex
Devart Team
Posts: 8082
Joined: Thu 14 Aug 2008 12:44

Re: Code templates documentation

Post by Shalex » Tue 06 Jun 2017 14:43

Your ORM is Entity Framework, isn't it?

Our documentation doesn't include reference for classes used in the templates, but there are some tips:
  • http://www.devart.com/entitydeveloper/e ... eloper.chm (do Properties > Unblock if content is not displayed) > Template System Concepts
  • use IntelliSense feature in our T4 Editor (completion list appears when you type the '.' character)
  • you can switch to the model in design time to read a description of a particular property in the Properties window
  • general T4 reference: http://msdn.microsoft.com/en-us/library/bb126478.aspx
  • use free JustDecompiler to decompile the following assemblies in C:\Program Files (x86)\Common Files\Devart\EntityDeveloper\ to get acquainted with the needed classes and their functionality:
    • EntityDeveloper.Common.dll
    • EntityDeveloper.Orm.Common.dll
    • EntityDeveloper.Orm.EntityFramework.dll
dambsst wrote:As example, how do you use output.Indent , output.IndentLiteral or output.IndentLength ?
EntityDeveloper.TemplateEngine.Output.Indent specifies the number of indents to be used.
Output.IndentLength specifies the number of IndentLiteral within each indent.
Output.IndentLiteral specifies the character used for indentation (space, tab, etc).
dambsst wrote:But the most important for me is to find out where to look for the documentation related to EntityRelationProperty, EntityAssociation, etc...
The public properties of the EntityRelationProperty and EntityAssociation classes have description available in design time (or in a decompiled code).

dambsst
Posts: 6
Joined: Sun 29 Jan 2017 15:10

Re: Code templates documentation

Post by dambsst » Tue 06 Jun 2017 17:25

Hello,

Thanks a lot!!!!

I will decompile the assemblies yes, I didn't know, and I will then be able to figure out how it works without doing several fails attempts from the T4 editor. It will be a very big help and time saver.

Yes my ORM is entity framework, but actually I am using it to build the layers and patterns for OData too (wcf data services in C#), to be used with asp, silverlight and later UWP if it's possible I don't know yet. That's why it is important for me to prevent any wrong read/write access to the database from the remote client.

Thanks again!

Best Regards,

Damien

Post Reply