Code Generation using Sitecore Rocks and Visual Studio

Sep 23, 2013

—

Harsh

in .NET, ASP.NET, Sitecore, Utility

Index Points

Introduction
Assumptions
Code Generation Steps using Sitecore Rocks
Image Guided Steps for Code Generation using Sitecore Rocks
Conclusion
Reference Links

Introduction

This post will guide you on how to work with code generation using Sitecore Rocks.

Assumptions

You have already setup Sitecore site visual studio solution.
- If not then you may follow the steps mentioned here on John West’s Blog or Check out Sitecore training series on YouTube – Sitecore Training : Developer Fundamental Series – Creating Visual Studio Project For Sitecore.
Installed and Configured Sitecore Rocks with Visual Studio solution for Sitecore site.
- If not then check the Sitecore training series on YouTube –

Code Generation Steps using Sitecore Rocks

For Code generation using Sitecore Rocks the steps are:

Setup the Sitecore site using .exe installer or Siteroot zip – available from Sitecore SDN.
Setup Sitecore site in Visual studio solution – Creating .sln file.
Install Sitecore Rocks (if not already installed).
Connect the Visual studio solution with Sitecore site using Hard Rock web service exposed by Sitecore.
Create new StronglyTypedItems file in Sitecore visual studio solution, extension will be .scx, with appropriate name – for example “CodeGenerationFile.scx”.
Right-click on created file “CodeGenerationFile.scx” and execute the command ‘Run Custom Tool’ for code generation.

Note: Check YouTube video series linked in assumption section for information on how to install and setup Sitecore Rocks and Sitecore Visual studio solution.

Image Guided Steps for Code Generation using Sitecore Rocks

The visual steps for Sitecore Rocks code generation are as below:

Create new file for Code generation
Right click on project > Add > New Item > Visual C# > Sitecore > Code Generation > select Strongly Typed Items > click Add

Run custom tool command to execute and generate code files

Verify the Code generated in CodeGenerationFile.Designer.cs file (File name may differ as per added file)

Conclusion

Code generation with Sitecore Rocks is very easy to follow. After generating code using Sitecore Rocks, developers may move the classes to relatively named class files by themselves or using command ‘Move class to file’ using ReSharper tool.

Reference Links

Do comment if you like this post or have any opinions.

code generation CodeGen Microsoft Visual Studio Sitecore Sitecore Rocks Visual Studio

Comments

4 responses to “Code Generation using Sitecore Rocks and Visual Studio”

Sen

September 28, 2013

Harsh! I will look for your comments on how useful is the code generation in Rocks if you compare with glass mapper!

Reply
1. Harsh Baid
  
  September 29, 2013
  
  Sure I will write soon post on using glass mapper and comparison of different code generation techniques using Sitecore Cms.
  
  Reply
Rita Vinchurkar

July 8, 2016

We have generated classes based on templates using guidelines provided above. We are not able to render image on .aspx page. Please help us regarding the same.

Reply
1. Harsh
  
  September 16, 2016
  
  As of today, I would advice to use glass mapper since it also provides rendering controls along with ORM features. When using Sitecore Rocks’ code generation you have to use the Sitecore provided controls for rendering images such as <sc:image /> control to keep supporting Experience Editor (previously Page Editor).
  
  Reply