AutoCAD Overrule .NET: Centerline Circle PropertiesOverrule Version 2

eachy

AutoCAD Overrule .NET: Centerline Circle PropertiesOverrule Version 2AutoCAD has provided the Overrule .NET API in recent versions. It is the most powerful .NET API so far and can provide almost the custom entity feature that is still only available in the most powerful AutoCAD API, ObjectARX. On the other hand, however, the Overrule API is also the most complex part in the AutoCAD .NET.
We have provided a Centerline Circle PropertiesOverrule before, but the first version of Centerline Circle PropertiesOverrule only lists out the Centerline Circle as custom name. In this post, let’s implement the PropertiesOverrule version 2 and add the critical ratio of length to diameter or half length to radius. Here is the code.

1. #region Namespaces
   
2. 
   
3. using System;
   
4. using System.Text;
   
5. using System.Linq;
   
6. using System.Xml;
   
7. using System.Reflection;
   
8. using System.ComponentModel;
   
9. using System.Collections;
   
10. using System.Collections.Generic;
    
11. using System.Windows;
    
12. using System.Windows.Media.Imaging;
    
13. using System.Windows.Forms;
    
14. using System.Diagnostics;
    
15. using System.Drawing;
    
16. using System.IO;
    
17. 
    
18. using Autodesk.AutoCAD.ApplicationServices;
    
19. using Autodesk.AutoCAD.DatabaseServices;
    
20. using Autodesk.AutoCAD.Runtime;
    
21. using Autodesk.AutoCAD.EditorInput;
    
22. using Autodesk.AutoCAD.Geometry;
    
23. using Autodesk.AutoCAD.Windows;
    
24. 
    
25. using MgdAcApplication = Autodesk.AutoCAD.ApplicationServices.Application;
    
26. using MgdAcDocument = Autodesk.AutoCAD.ApplicationServices.Document;
    
27. using AcWindowsNS = Autodesk.AutoCAD.Windows;
    
28. 
    
29. #endregion
    
30. 
    
31. using Autodesk.AutoCAD.GraphicsInterface;
    
32. 
    
33. namespace AcadNetAddinWizard_Namespace
    
34. {
    
35.     /// <summary>
    
36.     /// Features:
    
37.     ///     List out the custom name for the Centerline Circle when applicable.
    
38.     /// </summary>
    
39.     public class CenterlineCircle_PropertiesOverrule1 : PropertiesOverrule
    
40.     {
    
41.         private CenterlineCircle_PropertiesOverrule1()
    
42.         {
    
43.             //The overrule only works with certain circles marked with the Extension Dictionary Entry.
    
44.             SetExtensionDictionaryEntryFilter(CenterlineCircle_Gadgets.CLCircle_ID);
    
45. 
    
46.         }
    
47. 
    
48.         private static CenterlineCircle_PropertiesOverrule1 mInstance;
    
49.         public static CenterlineCircle_PropertiesOverrule1 Instance
    
50.         {
    
51.             get
    
52.             {
    
53.                 if (mInstance == null)
    
54.                     mInstance = new CenterlineCircle_PropertiesOverrule1();
    
55.                 return mInstance;
    
56.             }
    
57.         }
    
58. 
    
59.         public override void List(Entity entity)
    
60.         {
    
61.             base.List(entity);
    
62. 
    
63.             MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.WriteMessage("\nCustom name: {0}", CenterlineCircle_Gadgets.CLCircle_ID);
    
64. 
    
65.             double ratio = 1;
    
66.             object value = CenterlineCircle_Gadgets.GetDictionaryEntryTypedValue(
    
67.                             CenterlineCircle_Gadgets.GetExtensionDictionaryEntry(entity.ObjectId, CenterlineCircle_Gadgets.CLCircle_ID),
    
68.                             (int)DxfCode.ExtendedDataScale);
    
69.             if (value == null)
    
70.                 ratio = CenterlineCircle_Gadgets.DefaultRatioLengthToRadius;
    
71.             else
    
72.                 ratio = Convert.ToDouble(value);
    
73.             MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.WriteMessage("\nLength ratio: {0}", ratio);
    
74.         }
    
75.     }
    
76. }

#region Namespaces<br /> <br /> using System;<br /> using System.Text;<br /> using System.Linq;<br /> using System.Xml;<br /> using System.Reflection;<br /> using System.ComponentModel;<br /> using System.Collections;<br /> using System.Collections.Generic;<br /> using System.Windows;<br /> using System.Windows.Media.Imaging;<br /> using System.Windows.Forms;<br /> using System.Diagnostics;<br /> using System.Drawing;<br /> using System.IO;<br /> <br /> using Autodesk.AutoCAD.ApplicationServices;<br /> using Autodesk.AutoCAD.DatabaseServices;<br /> using Autodesk.AutoCAD.Runtime;<br /> using Autodesk.AutoCAD.EditorInput;<br /> using Autodesk.AutoCAD.Geometry;<br /> using Autodesk.AutoCAD.Windows;<br /> <br /> using MgdAcApplication = Autodesk.AutoCAD.ApplicationServices.Application;<br /> using MgdAcDocument = Autodesk.AutoCAD.ApplicationServices.Document;<br /> using AcWindowsNS = Autodesk.AutoCAD.Windows;<br /> <br /> #endregion<br /> <br /> using Autodesk.AutoCAD.GraphicsInterface;<br /> <br /> namespace AcadNetAddinWizard_Namespace<br /> {<br />     /// <summary><br />     /// Features:<br />     ///     List out the custom name for the Centerline Circle when applicable.<br />     /// </summary><br />     public class CenterlineCircle_PropertiesOverrule1 : PropertiesOverrule<br />     {<br />         private CenterlineCircle_PropertiesOverrule1()<br />         {<br />             //The overrule only works with certain circles marked with the Extension Dictionary Entry.<br />             SetExtensionDictionaryEntryFilter(CenterlineCircle_Gadgets.CLCircle_ID);<br /> <br />         }<br /> <br />         private static CenterlineCircle_PropertiesOverrule1 mInstance;<br />         public static CenterlineCircle_PropertiesOverrule1 Instance<br />         {<br />             get<br />             {<br />                 if (mInstance == null)<br />                     mInstance = new CenterlineCircle_PropertiesOverrule1();<br />                 return mInstance;<br />             }<br />         }<br /> <br />         public override void List(Entity entity)<br />         {<br />             base.List(entity);<br /> <br />             MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.WriteMessage("\nCustom name: {0}", CenterlineCircle_Gadgets.CLCircle_ID);<br /> <br />             double ratio = 1;<br />             object value = CenterlineCircle_Gadgets.GetDictionaryEntryTypedValue(<br />                             CenterlineCircle_Gadgets.GetExtensionDictionaryEntry(entity.ObjectId, CenterlineCircle_Gadgets.CLCircle_ID),<br />                             (int)DxfCode.ExtendedDataScale);<br />             if (value == null)<br />                 ratio = CenterlineCircle_Gadgets.DefaultRatioLengthToRadius;<br />             else<br />                 ratio = Convert.ToDouble(value);<br />             MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.WriteMessage("\nLength ratio: {0}", ratio);<br />         } <br />     }<br /> }

Here is the test command.

1. [CommandMethod("AddCLCirclePropertiesOverrule1")]
   
2. public static void AddCLCirclePropertiesOverrule1_Method()
   
3. {
   
4.     CenterlineCircle_Gadgets.RegisterOverrule(typeof(Circle), CenterlineCircle_PropertiesOverrule1.Instance);
   
5. }
   
6. 
   
7. [CommandMethod("RemoveCLCirclePropertiesOverrule1")]
   
8. public static void RemoveCLCirclePropertiesOverrule1_Method()
   
9. {
   
10.     CenterlineCircle_Gadgets.UnregisterOverrule(typeof(Circle), CenterlineCircle_PropertiesOverrule1.Instance);
    
11. }

[CommandMethod("AddCLCirclePropertiesOverrule1")]<br /> public static void AddCLCirclePropertiesOverrule1_Method()<br /> {<br />     CenterlineCircle_Gadgets.RegisterOverrule(typeof(Circle), CenterlineCircle_PropertiesOverrule1.Instance);<br /> }<br /> <br /> [CommandMethod("RemoveCLCirclePropertiesOverrule1")]<br /> public static void RemoveCLCirclePropertiesOverrule1_Method()<br /> {<br />     CenterlineCircle_Gadgets.UnregisterOverrule(typeof(Circle), CenterlineCircle_PropertiesOverrule1.Instance);<br /> }

Some highlights may look good to help understand the code.
&#8226; The centerline circle property overrule is derived from the PropertiesOverrule API class;
&#8226; The centerline circle PropertiesOverrule is made a singleton to avoid duplicate registrations or similar issues;
&#8226; The half-length to radius ratio is retrieved from the extension dictionary if any or uses the default value.