Topic: Custom Snippets

[Jeff H]

This is a quick example and is very easy and fast to set up. I just started setting up some templates  if anyone wants me to post them
This one does not have the reference and Namespace tags for inserting the using statements
When you insert it you type the command method name and it changes the method name and the ent type is a object so you get intellisense  I am sure you all
have used snippets

So if I in visual studo all have to do is right click insert Snippet Type Psr and press Tab twice and get

Code: [Select]

[CommandMethod("cv")]
        public static void cv()
        {
            Document doc = Application.DocumentManager.MdiActiveDocument;
            Database db = doc.Database;
            Editor ed = doc.Editor;
            PromptEntityOptions peo = new PromptEntityOptions("\nSelect Viewport");
            peo.SetRejectMessage("\nNot a Viewport");
            peo.AddAllowedClass(typeof(Viewport), true);
            PromptEntityResult per = ed.GetEntity(peo);
            if (per.Status != PromptStatus.OK)
                return;
            using (Transaction tr = db.TransactionManager.StartTransaction())
            {

            }

        }

This is the snippet XML snippet

Code: [Select]

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2008/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>Get Current BlockTable</Title>
      <Description>Add Code To get bt</Description>
      <Shortcut>Per</Shortcut>         
    </Header>
    <Snippet>     
      <Declarations>
        <Literal>
          <ID>CN</ID>
          <ToolTip>Replace with CommandName</ToolTip>
          <Default>CommandName</Default>
        </Literal>
        <Object>
          <ID>ENT</ID>
          <Type>Autodesk.AutoCAD.DatabaseServices.Entity</Type>
          <ToolTip>Replace with a connection object in your application.</ToolTip>
          <Default>dcConnection</Default>
        </Object>
      </Declarations>
        <Code Language="CSharp">
                <![CDATA[
         [CommandMethod("$CN$")]
        public static void $CN$()
        {
            Document doc = Application.DocumentManager.MdiActiveDocument;
            Database db = doc.Database;
            Editor ed = doc.Editor;
            PromptEntityOptions peo = new PromptEntityOptions("\nSelect $ENT$");
            peo.SetRejectMessage("\nNot a Viewport");
            peo.AddAllowedClass(typeof($ENT$), true);
            PromptEntityResult per = ed.GetEntity(peo);

            if (per.Status != PromptStatus.OK)
                return;
            using (Transaction tr = db.TransactionManager.StartTransaction())
            {
           
            }
        ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

But I thought maybe some of you would want them to set them how you like

[Kerry]

Seems a good place for this reminder
http://www.theswamp.org/index.php?topic=34068.msg393933#msg393933

[Kerry]

Declare AutoCAD Document,Editor,DataBase

Shortcut : kacDed   .. and Tab twice

[Kerry]

Write a message to CommandLine

Shortcut : kacMsg .. and Tab twice

[Kerry]

Prompts for entity selection and test

kacGetEntity_Test : tab twice

[Kerry]

I keep my snippets here :

C:\Users\ .... \Documents\Visual Studio 2010\Code Snippets\AutoCAD\kacDeclare Doc_Ed_Db.snippet
so Visual Studio can find them.


The reason I prefix snippets is to allow automatic listing by intellisence ..

eg type kac and all snippets prefixed with kac are listed

and the resulting code snip inserted

piccys :

[Jeff H]

I believe your setup is way better

[Kerry]

not better perhaps ...

uses the same snippets.
this is the XML for the WriteMessage

Code: [Select]


<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
      <Title>Write a message to CommandLine</Title>
      <Shortcut>kacMsg</Shortcut>
      <Description>Write a message to CommandLine</Description>
      <Author>KerryBrown</Author>
    </Header>
    <Snippet>
      <Declarations>
        <Literal Editable="true">
          <ID>editor</ID>
          <ToolTip>AcadApp.DocumentManager.MdiActiveDocument.Editor</ToolTip>
          <Default>ed</Default>
          <Function></Function>
        </Literal>
        <Literal Editable="true">
          <ID>message</ID>
          <ToolTip>Message string written to Command Line</ToolTip>
          <Default>message_stuff</Default>
          <Function></Function>
        </Literal>
      </Declarations>
      <Code Language="csharp"><![CDATA[$editor$.WriteMessage("\n$message$");$end$]]></Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

Thankfully the snippet XML does not need to be hand coded

[Kerry]

Creating and Using IntelliSense Code Snippets
http://msdn.microsoft.com/en-us/library/ms165392(v=VS.100).aspx

Snippet Designer Docs
http://snippetdesigner.codeplex.com/documentation


How Do I: Use Code Snippets in the Visual Studio IDE?  (video)
http://msdn.microsoft.com/en-us/vstudio/ee625748.aspx

[Bryco]

Since I use Line line=tr.getObject(  and Crcle circle=, I was trying to figure out how to do this in a  getobject snippet, but failed.
<![CDATA[$Type$ $ObjVarName$ = tr.GetObject($ObjectIdToOpen$, OpenMode$OpenMode$) as $Type$;$end$]]>
where $ObjVarName$ would =lowercase  $Type$

[Kerry]

Bryce,
I don't recall seeing anything that would allow that sort of dynamic default.
I'll have a look tonight.

[Kerry]

For anyone following along, this is the type of snippet Bryco was referring to ... without the dynamic VarName option.

attached:

[Jeff H]

Is that available in VS2008

[Kerry]

Is that available in VS2008

Yes, appears so.
http://snippetdesigner.codeplex.com/releases/view/43862

.. not sure if the 2008 version has been updated though.

[Kerry]

< snip >
where $ObjVarName$ would =lowercase  $Type$

Had a look over lunchtime Bryce.
I can't see any way to do that sort of dynamic assignment.
The Function Element is very restricted.

though, the current snippet only requires changes to 2 variables, so it's not too bad as is.