AutoCAD Overrule .NET: Register and Un-Register Overrules

eachy

             AutoCAD Overrule .NET: Register and Un-Register OverrulesAutoCAD 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 introduced various overrules for the Centerline Circle, which is a common drawing element in the engineering design world but is not provided by AutoCAD natively. Two help methods are used frequently to register and unregister those overrule instances. Here they are.

1. public static void RegisterOverrule(Type type, Overrule overrule)
   
2. {
   
3.     Editor ed = MgdAcApplication.DocumentManager.MdiActiveDocument.Editor;
   
4.     try
   
5.     {
   
6.         Overrule.AddOverrule(RXClass.GetClass(type), overrule, true);
   
7.         MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.Regen();
   
8.     }
   
9.     catch (Autodesk.AutoCAD.Runtime.Exception acadEx)
   
10.     {
    
11.         if (acadEx.ErrorStatus == ErrorStatus.DuplicateKey)
    
12.             ed.WriteMessage("\nThe Overrule has already been registered.");
    
13.         else
    
14.             ed.WriteMessage("\n" + acadEx.Message);
    
15.     }
    
16.     catch (System.Exception ex)
    
17.     {
    
18.         ed.WriteMessage(ex.Message);
    
19.     }
    
20. }
    
21. 
    
22. public static void UnregisterOverrule(Type type, Overrule overrule)
    
23. {
    
24.     Overrule.RemoveOverrule(RXClass.GetClass(type), overrule);
    
25.     MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.Regen();
    
26. }

public static void RegisterOverrule(Type type, Overrule overrule)<br /> {<br />     Editor ed = MgdAcApplication.DocumentManager.MdiActiveDocument.Editor;<br />     try<br />     {<br />         Overrule.AddOverrule(RXClass.GetClass(type), overrule, true);<br />         MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.Regen();<br />     }<br />     catch (Autodesk.AutoCAD.Runtime.Exception acadEx)<br />     {<br />         if (acadEx.ErrorStatus == ErrorStatus.DuplicateKey)<br />             ed.WriteMessage("\nThe Overrule has already been registered.");<br />         else<br />             ed.WriteMessage("\n" + acadEx.Message);<br />     }<br />     catch (System.Exception ex)<br />     {<br />         ed.WriteMessage(ex.Message);<br />     }<br /> }<br /> <br /> public static void UnregisterOverrule(Type type, Overrule overrule)<br /> {<br />     Overrule.RemoveOverrule(RXClass.GetClass(type), overrule);<br />     MgdAcApplication.DocumentManager.MdiActiveDocument.Editor.Regen();<br /> }

Here are some sample uses:

1. …
   
2.     CenterlineCircle_Gadgets.RegisterOverrule(typeof(Circle), CenterlineCircle_DrawableOverrule.Instance);
   
3. …
   
4.     CenterlineCircle_Gadgets.UnregisterOverrule(typeof(Circle), CenterlineCircle_DrawableOverrule.Instance);
   

…<br />     CenterlineCircle_Gadgets.RegisterOverrule(typeof(Circle), CenterlineCircle_DrawableOverrule.Instance);<br /> …<br />     CenterlineCircle_Gadgets.UnregisterOverrule(typeof(Circle), CenterlineCircle_DrawableOverrule.Instance);<br />

They are straightforward. We just wrapped the Overrule.AddOverrule() and the Overrule.RemoveOverrule() methods a bit, added the Editor.Region() call, and added exception handling to make things more convenience and reliable.