Using a palette from .NET to display properties of multiple AutoCAD objects

eachy

Using a palette from .NET to display properties of multiple AutoCAD objects                                                        After a brief interlude we're back on the series of posts showing how to implement basic user-interfaces inside AutoCAD using .NET. Here's the series so far:

• Using a modal .NET dialog to display AutoCAD object properties
• Using a modeless .NET dialog to display AutoCAD object properties
• Using a modeless .NET dialog to display properties of multiple AutoCAD objects
  

In this post we're going to swap out the modeless form we've been using in the last few posts in the series and replace it with an instance of AutoCAD's in-built palette class (Autodesk.AutoCAD.Windows.PaletteSet).
Firstly, why bother? Well, the PaletteSet class is realy cool: it provides docking, auto-hide, transparency and fixes the annoying focus-related issues we see with normal modeless dialogs.
And the best is that you get all this basically for free - the implementation work needed is really minimal. I started by copying liberal amounts of code from the DockingPalette sample on the ObjectARX SDK, and then deleted what wasn't needed for this project (which turned out to be most of it).
Here's the updated Command implementation. This really has very minor changes, as the palette implementation is all hidden inside the new TypeViewerPalette class.

1. using Autodesk.AutoCAD.ApplicationServices;
   
2. using Autodesk.AutoCAD.DatabaseServices;
   
3. using Autodesk.AutoCAD.EditorInput;
   
4. using Autodesk.AutoCAD.Runtime;
   
5. using System;
   
6. using CustomDialogs;
   
7. namespace CustomDialogs
   
8. {
   
9.   public class Commands : IExtensionApplication
   
10.   {
    
11.     static TypeViewerPalette tvp;
    
12.     public void Initialize()
    
13.     {
    
14.       tvp = new TypeViewerPalette();
    
15.       DocumentCollection dm =
    
16.         Application.DocumentManager;
    
17.       dm.DocumentCreated +=
    
18.         new DocumentCollectionEventHandler(OnDocumentCreated);
    
19.       foreach (Document doc in dm)
    
20.       {
    
21.         doc.Editor.PointMonitor +=
    
22.           new PointMonitorEventHandler(OnMonitorPoint);
    
23.       }
    
24.     }
    
25.     public void Terminate()
    
26.     {
    
27.       try
    
28.       {
    
29.         DocumentCollection dm =
    
30.           Application.DocumentManager;
    
31.         if (dm != null)
    
32.         {
    
33.           Editor ed = dm.MdiActiveDocument.Editor;
    
34.           ed.PointMonitor -=
    
35.             new PointMonitorEventHandler(OnMonitorPoint);
    
36.         }
    
37.       }
    
38.       catch (System.Exception)
    
39.       {
    
40.         // The editor may no longer
    
41.         // be available on unload
    
42.       }
    
43.     }
    
44.     private void OnDocumentCreated(
    
45.       object sender,
    
46.       DocumentCollectionEventArgs e
    
47.     )
    
48.     {
    
49.       e.Document.Editor.PointMonitor +=
    
50.         new PointMonitorEventHandler(OnMonitorPoint);
    
51.     }
    
52.     private void OnMonitorPoint(
    
53.       object sender,
    
54.       PointMonitorEventArgs e
    
55.     )
    
56.     {
    
57.       FullSubentityPath[] paths =
    
58.         e.Context.GetPickedEntities();
    
59.       if (paths.Length <= 0)
    
60.       {
    
61.         tvp.SetObjectId(ObjectId.Null);
    
62.         return;
    
63.       };
    
64.       ObjectIdCollection idc = new ObjectIdCollection();
    
65.       foreach (FullSubentityPath path in paths)
    
66.       {
    
67.         // Just add the first ID in the list from each path
    
68.         ObjectId[] ids = path.GetObjectIds();
    
69.         idc.Add(ids[0]);
    
70.       }
    
71.       tvp.SetObjectIds(idc);
    
72.     }
    
73.     [CommandMethod("vt",CommandFlags.UsePickSet)]
    
74.     public void ViewType()
    
75.     {
    
76.       tvp.Show();
    
77.     }
    
78.   }
    
79. }

using Autodesk.AutoCAD.ApplicationServices;<br /> using Autodesk.AutoCAD.DatabaseServices;<br /> using Autodesk.AutoCAD.EditorInput;<br /> using Autodesk.AutoCAD.Runtime;<br /> using System;<br /> using CustomDialogs;<br /> namespace CustomDialogs<br /> {<br />   public class Commands : IExtensionApplication<br />   {<br />     static TypeViewerPalette tvp;<br />     public void Initialize()<br />     {<br />       tvp = new TypeViewerPalette();<br />       DocumentCollection dm =<br />         Application.DocumentManager;<br />       dm.DocumentCreated +=<br />         new DocumentCollectionEventHandler(OnDocumentCreated);<br />       foreach (Document doc in dm)<br />       {<br />         doc.Editor.PointMonitor +=<br />           new PointMonitorEventHandler(OnMonitorPoint);<br />       }<br />     }<br />     public void Terminate()<br />     {<br />       try<br />       {<br />         DocumentCollection dm =<br />           Application.DocumentManager;<br />         if (dm != null)<br />         {<br />           Editor ed = dm.MdiActiveDocument.Editor;<br />           ed.PointMonitor -=<br />             new PointMonitorEventHandler(OnMonitorPoint);<br />         }<br />       }<br />       catch (System.Exception)<br />       {<br />         // The editor may no longer<br />         // be available on unload<br />       }<br />     }<br />     private void OnDocumentCreated(<br />       object sender,<br />       DocumentCollectionEventArgs e<br />     )<br />     {<br />       e.Document.Editor.PointMonitor +=<br />         new PointMonitorEventHandler(OnMonitorPoint);<br />     }<br />     private void OnMonitorPoint(<br />       object sender,<br />       PointMonitorEventArgs e<br />     )<br />     {<br />       FullSubentityPath[] paths =<br />         e.Context.GetPickedEntities();<br />       if (paths.Length <= 0)<br />       {<br />         tvp.SetObjectId(ObjectId.Null);<br />         return;<br />       };<br />       ObjectIdCollection idc = new ObjectIdCollection();<br />       foreach (FullSubentityPath path in paths)<br />       {<br />         // Just add the first ID in the list from each path<br />         ObjectId[] ids = path.GetObjectIds();<br />         idc.Add(ids[0]);<br />       }<br />       tvp.SetObjectIds(idc);<br />     }<br />     [CommandMethod("vt",CommandFlags.UsePickSet)]<br />     public void ViewType()<br />     {<br />       tvp.Show();<br />     }<br />   }<br /> }

As for the TypeViewerPalette class: I started by migrating the SetObjectId[ S  ]()   SetObjectText() protocol across from the old TypeViewerForm class - the most complicated part of which involved exposing the contents of our palette (which we define and load as a User Control) via a member variable that can be accessed from SetObjectText(). Other than that it was all just copy & paste.

1. using Autodesk.AutoCAD.ApplicationServices;
   
2. 
   
3. using Autodesk.AutoCAD.DatabaseServices;
   
4. using Autodesk.AutoCAD.EditorInput;
   
5. using Autodesk.AutoCAD.Interop;
   
6. using Autodesk.AutoCAD.Interop.Common;
   
7. using Autodesk.AutoCAD.Windows;
   
8. using TypeViewer;
   
9. 
   
10. namespace CustomDialogs
    
11. 
    
12. {
    
13.   public class TypeViewerPalette
    
14.   {
    
15.     // We cannot derive from PaletteSet
    
16.     // so we contain it
    
17.     static PaletteSet ps;
    
18.     // We need to make the textbox available
    
19.     // via a static member
    
20.     static TypeViewerControl tvc;
    
21.     public TypeViewerPalette()
    
22.     {
    
23.       tvc = new TypeViewerControl();
    
24.     }
    
25.     public void Show()
    
26.     {
    
27.       if (ps == null)
    
28.       {
    
29.         ps = new PaletteSet("Type Viewer");
    
30.         ps.Style =
    
31.           PaletteSetStyles.NameEditable |
    
32.           PaletteSetStyles.ShowPropertiesMenu |
    
33.           PaletteSetStyles.ShowAutoHideButton |
    
34.           PaletteSetStyles.ShowCloseButton;
    
35.         ps.MinimumSize =
    
36.           new System.Drawing.Size(300, 300);
    
37.         ps.Add("Type Viewer 1", tvc);
    
38.       }
    
39.       ps.Visible = true;
    
40.     }
    
41.     public void SetObjectText(string text)
    
42.     {
    
43.       tvc.typeTextBox.Text = text;
    
44.     }
    
45.     public void SetObjectIds(ObjectIdCollection ids)
    
46.     {
    
47.       if (ids.Count < 0)
    
48.       {
    
49.         SetObjectText("");
    
50.       }
    
51.       else
    
52.       {
    
53.         Document doc =
    
54.           Autodesk.AutoCAD.ApplicationServices.
    
55.             Application.DocumentManager.MdiActiveDocument;
    
56.         DocumentLock loc =
    
57.           doc.LockDocument();
    
58.         using (loc)
    
59.         {
    
60.           string info =
    
61.             "Number of objects: " +
    
62.             ids.Count.ToString() + "\r\n";
    
63.           Transaction tr =
    
64.             doc.TransactionManager.StartTransaction();
    
65.           using (tr)
    
66.           {
    
67.             foreach (ObjectId id in ids)
    
68.             {
    
69.               Entity ent =
    
70.                 (Entity)tr.GetObject(id, OpenMode.ForRead);
    
71.               Solid3d sol = ent as Solid3d;
    
72.               if (sol != null)
    
73.               {
    
74.                 Acad3DSolid oSol =
    
75.                   (Acad3DSolid)sol.AcadObject;
    
76.                 // Put in a try-catch block, as it's possible
    
77.                 // for solids to not support this property,
    
78.                 // it seems (better safe than sorry)
    
79.                 try
    
80.                 {
    
81.                   string solidType = oSol.SolidType;
    
82.                   info +=
    
83.                     ent.GetType().ToString() +
    
84.                     " (" + solidType + ") : " +
    
85.                     ent.ColorIndex.ToString() + "\r\n";
    
86.                 }
    
87.                 catch (System.Exception)
    
88.                 {
    
89.                   info +=
    
90.                     ent.GetType().ToString() +
    
91.                     " : " +
    
92.                     ent.ColorIndex.ToString() + "\r\n";
    
93.                 }
    
94.               }
    
95.               else
    
96.               {
    
97.                 info +=
    
98.                   ent.GetType().ToString() +
    
99.                   " : " +
    
100.                   ent.ColorIndex.ToString() + "\r\n";
     
101.               }
     
102.             }
     
103.             tr.Commit();
     
104.           }
     
105.           SetObjectText(info);
     
106.         }
     
107.       }
     
108.     }
     
109.     public void SetObjectId(ObjectId id)
     
110.     {
     
111.       if (id == ObjectId.Null)
     
112.       {
     
113.         SetObjectText("");
     
114.       }
     
115.       else
     
116.       {
     
117.         Document doc =
     
118.           Autodesk.AutoCAD.ApplicationServices.
     
119.             Application.DocumentManager.MdiActiveDocument;
     
120.         DocumentLock loc =
     
121.           doc.LockDocument();
     
122.         using (loc)
     
123.         {
     
124.           Transaction tr =
     
125.             doc.TransactionManager.StartTransaction();
     
126.           using (tr)
     
127.           {
     
128.             DBObject obj =
     
129.               tr.GetObject(id, OpenMode.ForRead);
     
130.             SetObjectText(obj.GetType().ToString());
     
131.             tr.Commit();
     
132.           }
     
133.         }
     
134.       }
     
135.     }
     
136.   }
     
137. }

using Autodesk.AutoCAD.ApplicationServices;<br /> <br /> using Autodesk.AutoCAD.DatabaseServices;<br /> using Autodesk.AutoCAD.EditorInput;<br /> using Autodesk.AutoCAD.Interop;<br /> using Autodesk.AutoCAD.Interop.Common;<br /> using Autodesk.AutoCAD.Windows;<br /> using TypeViewer;<br /> <br /> namespace CustomDialogs<br /> <br /> {<br />   public class TypeViewerPalette<br />   {<br />     // We cannot derive from PaletteSet<br />     // so we contain it<br />     static PaletteSet ps;<br />     // We need to make the textbox available<br />     // via a static member<br />     static TypeViewerControl tvc;<br />     public TypeViewerPalette()<br />     {<br />       tvc = new TypeViewerControl();<br />     }<br />     public void Show()<br />     {<br />       if (ps == null)<br />       {<br />         ps = new PaletteSet("Type Viewer");<br />         ps.Style =<br />           PaletteSetStyles.NameEditable |<br />           PaletteSetStyles.ShowPropertiesMenu |<br />           PaletteSetStyles.ShowAutoHideButton |<br />           PaletteSetStyles.ShowCloseButton;<br />         ps.MinimumSize =<br />           new System.Drawing.Size(300, 300);<br />         ps.Add("Type Viewer 1", tvc);<br />       }<br />       ps.Visible = true;<br />     }<br />     public void SetObjectText(string text)<br />     {<br />       tvc.typeTextBox.Text = text;<br />     }<br />     public void SetObjectIds(ObjectIdCollection ids)<br />     {<br />       if (ids.Count < 0)<br />       {<br />         SetObjectText("");<br />       }<br />       else<br />       {<br />         Document doc =<br />           Autodesk.AutoCAD.ApplicationServices.<br />             Application.DocumentManager.MdiActiveDocument;<br />         DocumentLock loc =<br />           doc.LockDocument();<br />         using (loc)<br />         {<br />           string info =<br />             "Number of objects: " +<br />             ids.Count.ToString() + "\r\n";<br />           Transaction tr =<br />             doc.TransactionManager.StartTransaction();<br />           using (tr)<br />           {<br />             foreach (ObjectId id in ids)<br />             {<br />               Entity ent =<br />                 (Entity)tr.GetObject(id, OpenMode.ForRead);<br />               Solid3d sol = ent as Solid3d;<br />               if (sol != null)<br />               {<br />                 Acad3DSolid oSol =<br />                   (Acad3DSolid)sol.AcadObject;<br />                 // Put in a try-catch block, as it's possible<br />                 // for solids to not support this property,<br />                 // it seems (better safe than sorry)<br />                 try<br />                 {<br />                   string solidType = oSol.SolidType;<br />                   info +=<br />                     ent.GetType().ToString() +<br />                     " (" + solidType + ") : " +<br />                     ent.ColorIndex.ToString() + "\r\n";<br />                 }<br />                 catch (System.Exception)<br />                 {<br />                   info +=<br />                     ent.GetType().ToString() +<br />                     " : " +<br />                     ent.ColorIndex.ToString() + "\r\n";<br />                 }<br />               }<br />               else<br />               {<br />                 info +=<br />                   ent.GetType().ToString() +<br />                   " : " +<br />                   ent.ColorIndex.ToString() + "\r\n";<br />               }<br />             }<br />             tr.Commit();<br />           }<br />           SetObjectText(info);<br />         }<br />       }<br />     }<br />     public void SetObjectId(ObjectId id)<br />     {<br />       if (id == ObjectId.Null)<br />       {<br />         SetObjectText("");<br />       }<br />       else<br />       {<br />         Document doc =<br />           Autodesk.AutoCAD.ApplicationServices.<br />             Application.DocumentManager.MdiActiveDocument;<br />         DocumentLock loc =<br />           doc.LockDocument();<br />         using (loc)<br />         {<br />           Transaction tr =<br />             doc.TransactionManager.StartTransaction();<br />           using (tr)<br />           {<br />             DBObject obj =<br />               tr.GetObject(id, OpenMode.ForRead);<br />             SetObjectText(obj.GetType().ToString());<br />             tr.Commit();<br />           }<br />         }<br />       }<br />     }<br />   }<br /> }

Here's what you get when you run the VT command and manipulate the palette's docking/transparency before hovering over a set of drawing objects:

You can download the source for this project from here