Revit二次开发 1、事务(Transaction)
[本内容个人为学习笔记,部分文字来自网络]
Transaction
在改变Revit中模型时,需要使用Transaction事务来进行处理,也就是创建、修改、删除Revit模型时,必须使用Transaction,在Transaction进行操作,否则Revit会抛出异常。
在使用Transaction时需要引入Atrributes空间:
using Autodesk.Revit.Attributes;
TransactionMode
Revit API中对于Revit事务没有默认值,用户必须出地指定标签值。
指定事务标签值的完整写法是:
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)]
因为前面引入Atrributes空间,在此可简写为:
[Transaction(TransactionMode.Manual)]
//[Transaction(TransactionMode.ReadOnly)]
早期的Revit API中TransactionMode有三个枚举值:Automatic、Manual和ReadOnly。
最新几个版本的Revit中只有两个枚举值:Manual和ReadOnly。
我们一般使用TransactionMode.Manual模式。
①TransactionMode.Automatic:
Revit会在调用外部命令之前自动创建一个Transaction,并且该Transaction会在外面命令结朿时提交或者回滚。如果外部命令执行成功,则提交Transaction;如果有异常,则回滚。在该模式下,外部命令不能再创建自己的Transaction,但是可以创建 SubTransactions。
②TransactionMode.Manual:
此模式表示Revit不会自动创建一个Transaction。如果用户需要修改Revit摸型,则需要自行创建Transaction,并且自行管理这个Transaction提交还是回滚。
③TransactionMode.ReadOnly:
在该模式下,外部命令不能有任何的Transaction,否则在创建Transaction或者修改 Revit文档都会抛出异常。此段落原文链接:https://blog.csdn.net/bbkxw001/article/details/78678137
Transaction的实现
Transaction的实现语法格式如下:
//开头要引用空间
using Autodesk.Revit.Attributes;
//进行事务之前,先获取要处理的文档
Document doc = commandData.Application.ActiveUIDocument.Document;
//定义事务:事务变量名trans(自定)
// 事务名为字符串(自定)
using(Transaction trans = new Transaction(doc, "事务名"))
{
//开始
trans.Start();
//==================
//此处写入自己的模型修改处理语句
//==================
//完成事务进行提交并结束本次事务处理
trans.Commit();
//若事务取消,本事务的操作回滚,也结束本次事务
//trans.RollBack();
}
事务实现的语句中,可以不使用using语句,样式如下:
Transaction trans = new Transaction(doc, "事务名");
//开始
trans.Start();
//==================
//此处写入自己的模型修改处理语句
//==================
//完成事务进行提交并结束本次事务处理
trans.Commit();
//若事务取消,本事务的操作回滚,也结束本次事务
//trans.RollBack();
但是,为了语句结构,建议采用using语句方式。
其它相关
[以下部分的更详细内容待进一步学习]
SubTransaction
一个SubTransaction(子事务)可以用来提交一组操作。子事务是可选项,不是必须的。它们是用来将一个复杂的任务分解成许多小任务来提交。
TransactionGroup
TransactionGroup用来将几个独立的事务分组,这样一个组可以同时处理许多事务。
Regeneration
RegenerationAttribute——模型更新模式;旧版Revit的API中的Regeneration有Automatic和Manual两种枚举值,新版Revit的API中只有RegenerationOption.Manual一种模式,一般不常用。
[Regeneration(RegenerationOption.Manual)]
①RegenerationOption.Manual: 执行的操作需要在Document调用Regenerate时模型才会更新。
②RegenerationOption.Automatic: 每一步修改操作会自动更新到界面图形中。
JournalingAttribute
JournalingAttribute ——日志模式;有JournalingMode.UsingCommandData和JournalingMode.NoCommandData两种模式。
[Journaling(JournalingMode.UsingCommandData)]
很少用。
结束语
以上内容是Revit二次开发中最常用的外部命令程序的开始部分,用于在外部命令程序前设置外部命令的属性:事务属性和更新属性。这也是进行Revit二次开发最开始的两条语句。其实,这部分也就相当于Revit二次开发的框架,基本上是固定的内容。
第一次发文,部分内容来自网络同仁的文章,若有侵权请告知。