该类是Revit API中的一个内置失败类型(Built-In Failure),用于表示元素编号(Element Numbering)相关的失败情况。其定义了以下几种失败类型:
当Revit应用程序检测到这些失败情况时,可以使用该类来创建失败消息,提示用户执行必要的修复操作。例如:
IDocument doc = uidoc.Document;
BuiltInFailures failures = BuiltInFailures.NumberingFailures;
FailureMessage fm = new FailureMessage(failures.InvalidElementNumber);
fm.SetDescriptionString("The element number is invalid. Please enter a valid number.");
doc.PostFailure(fm);
以上代码将创建一个“元素编号无效”的失败消息,并显示给用户。用户根据提示进行操作后,可以使用doc.DeleteAllWarnings()
方法删除所有失败消息。
注意:在使用该类创建失败消息时,需要明确指定失败类型。