Skip to main content

Creating our own 'Code Snippets' in Visual Studio .NET 2005

Code Snippets are useful in situations where you frequently implement the same code blocks in multiple places within your project.

One could find all existing snippets for C# in this folder:
C:\Program Files\Microsoft Visual Studio 8\VC#\Snippets\1033\Visual C#

If you want to create your own snippet which is not existing in the above path then do the following:

1. In Visual Studio.NET, Create a New Xml File.
2. Place the following XML code into that file:

The root element for an code snippet is <CodeSnippet>. This would have two child elements <Header> and <Snippet>

<?xml version= "1.0" encoding="utf-8" ?>
<CodeSnippets xmlns = "http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
<CodeSnippet Format ="1.0.0">


<Header >
<Title> Title of the Code Snippet would come here </Title>
<Author> Vadivel Mohanakrishnan </Author>
<Description> Describe it in detail here </Description>
<Shortcut> vel </Shortcut>
</Header>

<Snippet>
<Code Language=" CSharp">
<![CDATA[
//Your code block needs to be placed here.
]]>
</Code>
</Snippet>

</CodeSnippet>
</CodeSnippets>

3. Using "Save As" dialog box, save it as 'MySnippet.snippet' on C drive (for example). Its because, Code Snippet is nothing but a XML file.

Now within your Visual Studio.NET 2005 do the following:

1. In the tools menu, select "Code Snippet Manager". Please note that by default "Code Snippet Manager" may not be visible. So go to Tools - Options and choose it for the first time.

2. Then, click on 'Import' button and locate the new snippet on your desktop. During that process if it throws an error like "The snippet files chosen were not valid" it means there is some error in the XML file. Fix it and try again.

3. Place the snippet under "My code snippets".

4. That's it you are done. Now open any file (.cs, class module etc.,) and right click and choose "Code Snippet". You could see our newly created snippet there. On click of it would place the code whatever we have written in our XML file.

5. Other way is to just type the shortcut (in this case its just vel) and press the TAB key.

For further reading on this topic I suggest you to go through these links: http://msdn.microsoft.com/vstudio/downloads/codesnippets/ and dotnetfun.com

Technorati tags: , ,

Comments

Anonymous said…
Awsome guide! thanks helped me alot to get my snippets working :)

Popular posts from this blog

Script table as - ALTER TO is greyed out - SQL SERVER

One of my office colleague recently asked me why we are not able to generate ALTER Table script from SSMS. If we right click on the table and choose "Script Table As"  ALTER To option would be disabled or Greyed out. Is it a bug? No it isn't a bug. ALTER To is there to be used for generating modified script of Stored Procedure, Functions, Views, Triggers etc., and NOT for Tables. For generating ALTER Table script there is an work around. Right click on the table, choose "Modify" and enter into the design mode. Make what ever changes you want to make and WITHOUT saving it right click anywhere on the top half of the window (above Column properties) and choose "Generate Change Script". Please be advised that SQL Server would drop actually create a new table with modifications, move the data from the old table into it and then drop the old table. Sounds simple but assume you have a very large table for which you want to do this! Then it woul

AWS fatal error: An error occurred (400) when calling the HeadObject operation: Bad Request

While using AWS and trying to copy a file from a S3 bucket to my EC2 instance ended up with this error message. Command Used: aws s3 cp s3://mybucketname/myfilename.html /var/www/html/ Error: fatal error: An error occurred (400) when calling the HeadObject operation: Bad Request The error goes off if we add the region information to the command statement. I am using Asia Pacific (Mumbai) so used ap-south-1 as the region name. Modified Command: aws s3 cp s3://mybucketname/myfilename.html /var/www/html/ --region ap-south-1

[Non Tech] Want to know the recipe for Omelette :)

Fed up with Bread - Jam and Curd Rice, today i wanted to eat Omelette. Interesting part is I wanted to cook it myself :) So in the first picture you see all the items which are needed for preparing an Omelette. When I had a closer look at the eggs I see that almost all the eggs are broken. But believe me when I bought it couple of days back it was in perfect condition! I was wondering whether the eggs have become rotten or pretty old to consume! I tried taking an egg and break it but couldn't break it at all :) Since I have kept in the freezer all the eggs have frozen and looked like a iron ball :) After trying for few minutes of trying i removed the shell of the egg and then kept that iron ball :) into a bowl and placed it within Oven. I heated it for 1 minute and checked. It melted only to a limit. So i just set it for another 2 minutes and checked it later. It has melted but the part of the egg white has become a Omelette :( I didn't leave it there. I took the bowl out of