【转载】AutoCAD二次开发&创建和获取扩展字典对象与扩展记录数据

qq1254582201

这是一个与学习创建和获取扩展字典对象与扩展记录数据相关的内容。我们知道在南方cass中有一部分数据是存在扩展数据xdata属性中，其中宗地的宗地基本属性就是印证了这一点。而我们接下了的学习是字典Dictionary扩展数据、扩展记录数据Xrecord。这对了解AutoCAD扩展数据具有一定帮助。

工程的代码是摘自相关网站，源代码使用的是..net6.0，由于本次使用的是AutoCAD2010，因此版本为net3.5，而相应的函数是在原有类的基础上扩展得来的，比如string.IsNullOrWhiteSpace（），单独写一个关于string的扩展函数IsNullOrWhiteSpace()。而代码中出现的nameof函数，用于获取类型等信息标记异常信息，这里使用另外的一些标记代替。具体可以参考提供的源代码。下面的源代码中函数GetObject是一泛型方法，其中还使用了where关键字对基类进行了约束。其他函数的使用看注释即可。

相关扩展字典操作类。

1. using Autodesk.AutoCAD.DatabaseServices;
   
2. using Autodesk.AutoCAD.Runtime;
   
3. using System;
   
4. using System.Collections.Generic;
   
5. using System.Linq;
   
6. using System.Text;
   
7. 
   
8. namespace HandleXDictionaryXrecords
   
9. {
   
10.     public static class Extension
    
11.     {
    
12.       public static T GetObject<T>(
    
13.        this ObjectId id,
    
14.        OpenMode mode = OpenMode.ForRead,
    
15.        bool openErased = false,
    
16.        bool forceOpenOnLockedLayer = false)
    
17.        where T : DBObject
    
18.         {
    
19.             if (id.IsNull)
    
20.                 throw new Autodesk.AutoCAD.Runtime.Exception(ErrorStatus.NullObjectId);
    
21.             Transaction tr = id.Database.TransactionManager.TopTransaction;
    
22.             if (tr == null)
    
23.                 throw new Autodesk.AutoCAD.Runtime.Exception(ErrorStatus.NoActiveTransactions);
    
24.             return (T)tr.GetObject(id, mode, openErased, forceOpenOnLockedLayer);
    
25.         }
    
26.       /// <summary>
    
27.       /// 获取扩展字典
    
28.       /// </summary>
    
29.       /// <param name="source"></param>
    
30.       /// <returns></returns>
    
31.       public static DBDictionary TryGetExtensionDictionary(this DBObject source)
    
32.       {
    
33.           if (source == null)
    
34.               throw new ArgumentNullException("source为空");
    
35.           ObjectId dictId = source.ExtensionDictionary;
    
36.           if (dictId == ObjectId.Null)
    
37.           {
    
38.               return null;
    
39.           }
    
40.           return dictId.GetObject<DBDictionary>();
    
41.       }
    
42.       /// <summary>
    
43.       /// 获取或创建字典
    
44.       /// </summary>
    
45.       /// <param name="source"></param>
    
46.       /// <returns></returns>
    
47.       public static DBDictionary GetOrCreateExtensionDictionary(this DBObject source)
    
48.       {
    
49.           if (source == null)
    
50.               throw new ArgumentNullException("source为空");
    
51.           if (source.ExtensionDictionary == ObjectId.Null)
    
52.           {
    
53.               source.UpgradeOpen();
    
54.               source.CreateExtensionDictionary();
    
55.           }
    
56.           return source.ExtensionDictionary.GetObject<DBDictionary>();
    
57.       }
    
58.         /// <summary>
    
59.         /// 获取扩展字典
    
60.         /// </summary>
    
61.         /// <param name="source">数据对象</param>
    
62.         /// <param name="key">键</param>
    
63.         /// <returns></returns>
    
64.       public static ResultBuffer GetXDictionaryXrecordData(this DBObject source, string key)
    
65.       {
    
66.           if (source == null)
    
67.               //throw new ArgumentNullException(nameof(source));
    
68.               throw new ArgumentNullException("source为空");
    
69.           //if (string.IsNullOrWhiteSpace(key))
    
70.           if (key.IsNullOrWhiteSpace())
    
71.               throw new ArgumentNullException("key或为空");
    
72.           DBDictionary xdict = source.TryGetExtensionDictionary();
    
73.           if (xdict == null)
    
74.           {
    
75.               return null;
    
76.           }
    
77.           return xdict.GetXrecordData(key);
    
78.       }
    
79.       /// <summary>
    
80.       /// 设置字典
    
81.       /// </summary>
    
82.       /// <param name="target"></param>
    
83.       /// <param name="key"></param>
    
84.       /// <param name="values"></param>
    
85.       public static void SetXDictionaryXrecordData(this DBObject target, string key, params TypedValue[] values)
    
86.       {
    
87.           target.SetXDictionaryXrecordData(key, new ResultBuffer(values));
    
88.       }
    
89.       /// <summary>
    
90.       /// 创建字典
    
91.       /// </summary>
    
92.       /// <param name="target"></param>
    
93.       /// <param name="key"></param>
    
94.       /// <param name="data"></param>
    
95.       public static void SetXDictionaryXrecordData(this DBObject target, string key, ResultBuffer data)
    
96.       {
    
97.           if (target == null)
    
98.               //throw new ArgumentNullException(nameof(target));
    
99.               throw new ArgumentNullException("target为空");
    
100.           //if (string.IsNullOrWhiteSpace(key))
     
101.           if (key.IsNullOrWhiteSpace())
     
102.               //throw new ArgumentNullException(nameof(key));
     
103.               throw new ArgumentNullException("key或为空");
     
104.           target.GetOrCreateExtensionDictionary().SetXrecordData(key, data);
     
105.       }
     
106.       /// <summary>
     
107.       /// 获取扩展记录数据
     
108.       /// </summary>
     
109.       /// <param name="dict"></param>
     
110.       /// <param name="key"></param>
     
111.       /// <returns></returns>
     
112.       public static ResultBuffer GetXrecordData(this DBDictionary dict, string key)
     
113.       {
     
114.           if (dict == null)
     
115.               //throw new ArgumentNullException(nameof(dict));
     
116.               throw new ArgumentNullException("dict为空");
     
117.           if (!dict.Contains(key))
     
118.           {
     
119.               return null;
     
120.           }
     
121.           ObjectId id = (ObjectId)dict[key];
     
122.           if (id.ObjectClass != RXObject.GetClass(typeof(Xrecord)))
     
123.               return null;
     
124.           return id.GetObject<Xrecord>().Data;
     
125.       }
     
126.         /// <summary>
     
127.         /// 设置扩展记录数据
     
128.         /// </summary>
     
129.         /// <param name="dict"></param>
     
130.         /// <param name="key"></param>
     
131.         /// <param name="data"></param>
     
132.       public static void SetXrecordData(this DBDictionary dict, string key, ResultBuffer data)
     
133.       {
     
134.           if (dict == null)
     
135.            //   throw new ArgumentNullException(nameof(dict));
     
136.               throw new ArgumentNullException("dict为空");
     
137.           //if (string.IsNullOrWhiteSpace(key))
     
138.            if( key.IsNullOrWhiteSpace())
     
139.               //throw new ArgumentNullException(nameof(key));
     
140.                throw new ArgumentNullException("key或为空");
     
141.           Transaction tr = dict.Database.TransactionManager.TopTransaction;
     
142.           if (tr == null)
     
143.               throw new Autodesk.AutoCAD.Runtime.Exception(ErrorStatus.NoActiveTransactions);
     
144.           Xrecord xrec;
     
145.           if (dict.Contains(key))
     
146.           {
     
147.               xrec = ((ObjectId)dict[key]).GetObject<Xrecord>(OpenMode.ForWrite);
     
148.           }
     
149.           else
     
150.           {
     
151.               dict.UpgradeOpen();
     
152.               xrec = new Xrecord();
     
153.               dict.SetAt(key, xrec);
     
154.               tr.AddNewlyCreatedDBObject(xrec, true);
     
155.           }
     
156.           xrec.Data = data;
     
157.       }
     
158. 
     
159.     }
     
160. 
     
161. 
     
162. }

using Autodesk.AutoCAD.DatabaseServices;<br /> using Autodesk.AutoCAD.Runtime;<br /> using System;<br /> using System.Collections.Generic;<br /> using System.Linq;<br /> using System.Text;<br /> <br /> namespace HandleXDictionaryXrecords<br /> {<br />     public static class Extension<br />     {<br />       public static T GetObject<T>(<br />        this ObjectId id,<br />        OpenMode mode = OpenMode.ForRead,<br />        bool openErased = false,<br />        bool forceOpenOnLockedLayer = false)<br />        where T : DBObject<br />         {<br />             if (id.IsNull)<br />                 throw new Autodesk.AutoCAD.Runtime.Exception(ErrorStatus.NullObjectId);<br />             Transaction tr = id.Database.TransactionManager.TopTransaction;<br />             if (tr == null)<br />                 throw new Autodesk.AutoCAD.Runtime.Exception(ErrorStatus.NoActiveTransactions);<br />             return (T)tr.GetObject(id, mode, openErased, forceOpenOnLockedLayer);<br />         }<br />       /// <summary><br />       /// 获取扩展字典<br />       /// </summary><br />       /// <param name="source"></param><br />       /// <returns></returns><br />       public static DBDictionary TryGetExtensionDictionary(this DBObject source)<br />       {<br />           if (source == null)<br />               throw new ArgumentNullException("source为空");<br />           ObjectId dictId = source.ExtensionDictionary;<br />           if (dictId == ObjectId.Null)<br />           {<br />               return null;<br />           }<br />           return dictId.GetObject<DBDictionary>();<br />       }<br />       /// <summary><br />       /// 获取或创建字典<br />       /// </summary><br />       /// <param name="source"></param><br />       /// <returns></returns><br />       public static DBDictionary GetOrCreateExtensionDictionary(this DBObject source)<br />       {<br />           if (source == null)<br />               throw new ArgumentNullException("source为空");<br />           if (source.ExtensionDictionary == ObjectId.Null)<br />           {<br />               source.UpgradeOpen();<br />               source.CreateExtensionDictionary();<br />           }<br />           return source.ExtensionDictionary.GetObject<DBDictionary>();<br />       }<br />         /// <summary><br />         /// 获取扩展字典<br />         /// </summary><br />         /// <param name="source">数据对象</param><br />         /// <param name="key">键</param><br />         /// <returns></returns><br />       public static ResultBuffer GetXDictionaryXrecordData(this DBObject source, string key)<br />       {<br />           if (source == null)<br />               //throw new ArgumentNullException(nameof(source));<br />               throw new ArgumentNullException("source为空");<br />           //if (string.IsNullOrWhiteSpace(key))<br />           if (key.IsNullOrWhiteSpace())<br />               throw new ArgumentNullException("key或为空");<br />           DBDictionary xdict = source.TryGetExtensionDictionary();<br />           if (xdict == null)<br />           {<br />               return null;<br />           }<br />           return xdict.GetXrecordData(key);<br />       }<br />       /// <summary><br />       /// 设置字典<br />       /// </summary><br />       /// <param name="target"></param><br />       /// <param name="key"></param><br />       /// <param name="values"></param><br />       public static void SetXDictionaryXrecordData(this DBObject target, string key, params TypedValue[] values)<br />       {<br />           target.SetXDictionaryXrecordData(key, new ResultBuffer(values));<br />       }<br />       /// <summary><br />       /// 创建字典<br />       /// </summary><br />       /// <param name="target"></param><br />       /// <param name="key"></param><br />       /// <param name="data"></param><br />       public static void SetXDictionaryXrecordData(this DBObject target, string key, ResultBuffer data)<br />       {<br />           if (target == null)<br />               //throw new ArgumentNullException(nameof(target));<br />               throw new ArgumentNullException("target为空");<br />           //if (string.IsNullOrWhiteSpace(key))<br />           if (key.IsNullOrWhiteSpace())<br />               //throw new ArgumentNullException(nameof(key));<br />               throw new ArgumentNullException("key或为空");<br />           target.GetOrCreateExtensionDictionary().SetXrecordData(key, data);<br />       }<br />       /// <summary><br />       /// 获取扩展记录数据<br />       /// </summary><br />       /// <param name="dict"></param><br />       /// <param name="key"></param><br />       /// <returns></returns><br />       public static ResultBuffer GetXrecordData(this DBDictionary dict, string key)<br />       {<br />           if (dict == null)<br />               //throw new ArgumentNullException(nameof(dict));<br />               throw new ArgumentNullException("dict为空");<br />           if (!dict.Contains(key))<br />           {<br />               return null;<br />           }<br />           ObjectId id = (ObjectId)dict[key];<br />           if (id.ObjectClass != RXObject.GetClass(typeof(Xrecord)))<br />               return null;<br />           return id.GetObject<Xrecord>().Data;<br />       }<br />         /// <summary><br />         /// 设置扩展记录数据<br />         /// </summary><br />         /// <param name="dict"></param><br />         /// <param name="key"></param><br />         /// <param name="data"></param><br />       public static void SetXrecordData(this DBDictionary dict, string key, ResultBuffer data)<br />       {<br />           if (dict == null)<br />            //   throw new ArgumentNullException(nameof(dict));<br />               throw new ArgumentNullException("dict为空");<br />           //if (string.IsNullOrWhiteSpace(key))<br />            if( key.IsNullOrWhiteSpace())<br />               //throw new ArgumentNullException(nameof(key));<br />                throw new ArgumentNullException("key或为空");<br />           Transaction tr = dict.Database.TransactionManager.TopTransaction;<br />           if (tr == null)<br />               throw new Autodesk.AutoCAD.Runtime.Exception(ErrorStatus.NoActiveTransactions);<br />           Xrecord xrec;<br />           if (dict.Contains(key))<br />           {<br />               xrec = ((ObjectId)dict[key]).GetObject<Xrecord>(OpenMode.ForWrite);<br />           }<br />           else<br />           {<br />               dict.UpgradeOpen();<br />               xrec = new Xrecord();<br />               dict.SetAt(key, xrec);<br />               tr.AddNewlyCreatedDBObject(xrec, true);<br />           }<br />           xrec.Data = data;<br />       }<br /> <br />     }<br /> <br /> <br /> }

最后是一个测试类。

using Autodesk.AutoCAD.ApplicationServices;
using Autodesk.AutoCAD.DatabaseServices;
using Autodesk.AutoCAD.EditorInput;
using Autodesk.AutoCAD.Runtime;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace HandleXDictionaryXrecords
{
    /// <summary>
    /// 测试类
    /// </summary>
    class XrecordTest
    {

        [CommandMethod("XRECTEST")]
        public static void XrecordTest() {
            Document doc = Application.DocumentManager.MdiActiveDocument;
            Database db = doc.Database;
            Editor ed = doc.Editor;
            PromptEntityResult per = ed.GetEntity("\n选择一个实体: ");
            if (per.Status == PromptStatus.OK)
            {
                using (var tr = db.TransactionManager.StartTransaction())
                {
                    Entity ent = (Entity)tr.GetObject(per.ObjectId, OpenMode.ForRead);
                    ResultBuffer data = ent.GetXDictionaryXrecordData("TestXrec");
                    if (data == null)
                    {
                        ed.WriteMessage("\n实体不存在交 'TextXrec' Xrecord记录, 将添加到Xrecord记录中");
                        ent.SetXDictionaryXrecordData("TestXrec", new TypedValue(1, "foo"), new TypedValue(70, 42));
                    }
                    else
                    {
                        foreach (TypedValue tv in data.AsArray())
                        {
                            ed.WriteMessage("\nTypeCode: {"+tv.TypeCode.ToString()+"}, Value: {"+tv.Value.ToString()+"}");
                        }
                    }
                    tr.Commit();
                }
            }
        }
    }
}
在visual studio中编译好源代码后，在命令行输入netload加载生成的dll,然后再运行XRECTEST命令，按照相关步骤执行即可。
————————————————

                            版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

原文链接：https://blog.csdn.net/u010608964/article/details/82026368

qq1254582201

2. /// <summary>
   
3.         /// Add or edit a Xrecord data in a named dictionary (the dictionary and xrecord are created if not already exist)
   
4.         /// </summary>
   
5.         /// <param name="dictName">The dictionary name</param>
   
6.         /// <param name="key">the xrecord key</param>
   
7.         /// <param name="resbuf">the xrecord data</param>
   
8.         public void SetXrecord(string dictName, string key, ResultBuffer resbuf)
   
9.         {
   
10.             Document doc = acadApp.DocumentManager.MdiActiveDocument;
    
11.             Database db = doc.Database;
    
12.             using (Transaction tr = db.TransactionManager.StartTransaction())
    
13.             {
    
14.                 DBDictionary NOD =
    
15.                     (DBDictionary)tr.GetObject(db.NamedObjectsDictionaryId, OpenMode.ForRead);
    
16.                 DBDictionary dict;
    
17.                 if (NOD.Contains(dictName))
    
18.                 {
    
19.                     dict = (DBDictionary)tr.GetObject(NOD.GetAt(dictName), OpenMode.ForWrite);
    
20.                 }
    
21.                 else
    
22.                 {
    
23.                     dict = new DBDictionary();
    
24.                     NOD.UpgradeOpen();
    
25.                     NOD.SetAt(dictName, dict);
    
26.                     tr.AddNewlyCreatedDBObject(dict, true);
    
27.                 }
    
28.                 Xrecord xRec = new Xrecord();
    
29.                 xRec.Data = resbuf;
    
30.                 dict.SetAt(key, xRec);
    
31.                 tr.AddNewlyCreatedDBObject(xRec, true);
    
32.                 tr.Commit();
    
33.             }
    
34.         }
    
35. 
    
36.         /// <summary>
    
37.         /// Gets an xrecord data in a named dictionary
    
38.         /// </summary>
    
39.         /// <param name="dictName">The dictionary name</param>
    
40.         /// <param name="key">The xrecord key</param>
    
41.         /// <returns>The xrecord data or null if the dictionary or the xrecord do not exist</returns>
    
42.         public ResultBuffer GetXrecord(string dictName, string key)
    
43.         {
    
44.             Document doc = acadApp.DocumentManager.MdiActiveDocument;
    
45.             Database db = doc.Database;
    
46.             using (Transaction tr = db.TransactionManager.StartTransaction())
    
47.             {
    
48.                 DBDictionary NOD =
    
49.                     (DBDictionary)tr.GetObject(db.NamedObjectsDictionaryId, OpenMode.ForRead);
    
50.                 if (!NOD.Contains(dictName))
    
51.                     return null;
    
52.                 DBDictionary dict = tr.GetObject(NOD.GetAt(dictName), OpenMode.ForRead) as DBDictionary;
    
53.                 if (dict == null || !dict.Contains(key))
    
54.                     return null;
    
55.                 Xrecord xRec = tr.GetObject(dict.GetAt(key), OpenMode.ForRead) as Xrecord;
    
56.                 if (xRec == null)
    
57.                     return null;
    
58.                 return xRec.Data;
    
59.             }
    
60.         }

/// <summary><br />         /// Add or edit a Xrecord data in a named dictionary (the dictionary and xrecord are created if not already exist)<br />         /// </summary><br />         /// <param name="dictName">The dictionary name</param><br />         /// <param name="key">the xrecord key</param><br />         /// <param name="resbuf">the xrecord data</param><br />         public void SetXrecord(string dictName, string key, ResultBuffer resbuf)<br />         {<br />             Document doc = acadApp.DocumentManager.MdiActiveDocument;<br />             Database db = doc.Database;<br />             using (Transaction tr = db.TransactionManager.StartTransaction())<br />             {<br />                 DBDictionary NOD = <br />                     (DBDictionary)tr.GetObject(db.NamedObjectsDictionaryId, OpenMode.ForRead);<br />                 DBDictionary dict;<br />                 if (NOD.Contains(dictName))<br />                 {<br />                     dict = (DBDictionary)tr.GetObject(NOD.GetAt(dictName), OpenMode.ForWrite);<br />                 }<br />                 else<br />                 {<br />                     dict = new DBDictionary();<br />                     NOD.UpgradeOpen();<br />                     NOD.SetAt(dictName, dict);<br />                     tr.AddNewlyCreatedDBObject(dict, true);<br />                 }<br />                 Xrecord xRec = new Xrecord();<br />                 xRec.Data = resbuf;<br />                 dict.SetAt(key, xRec);<br />                 tr.AddNewlyCreatedDBObject(xRec, true);<br />                 tr.Commit();<br />             }<br />         }<br /> <br />         /// <summary><br />         /// Gets an xrecord data in a named dictionary<br />         /// </summary><br />         /// <param name="dictName">The dictionary name</param><br />         /// <param name="key">The xrecord key</param><br />         /// <returns>The xrecord data or null if the dictionary or the xrecord do not exist</returns><br />         public ResultBuffer GetXrecord(string dictName, string key)<br />         {<br />             Document doc = acadApp.DocumentManager.MdiActiveDocument;<br />             Database db = doc.Database;<br />             using (Transaction tr = db.TransactionManager.StartTransaction())<br />             {<br />                 DBDictionary NOD = <br />                     (DBDictionary)tr.GetObject(db.NamedObjectsDictionaryId, OpenMode.ForRead);<br />                 if (!NOD.Contains(dictName))<br />                     return null;<br />                 DBDictionary dict = tr.GetObject(NOD.GetAt(dictName), OpenMode.ForRead) as DBDictionary;<br />                 if (dict == null || !dict.Contains(key))<br />                     return null;<br />                 Xrecord xRec = tr.GetObject(dict.GetAt(key), OpenMode.ForRead) as Xrecord;<br />                 if (xRec == null)<br />                     return null;<br />                 return xRec.Data;<br />             }<br />         }