Autodesk.Revit.DB.HostObjectUtils
简介
Autodesk.Revit.DB.HostObjectUtils是Revit软件中的一个类,用于提供与宿主对象相关的工具方法,例如检查宿主对象是否可以进行修改/删除,创建宿主对象的副本等。
主要方法
CanBeHidden(HostObject)
判断指定的宿主对象是否可以隐藏。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
返回值:
- bool类型,true表示宿主对象可以隐藏,false表示宿主对象不能隐藏。
CanBeLocked(HostObject)
判断指定的宿主对象是否可以锁定。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
返回值:
- bool类型,true表示宿主对象可以锁定,false表示宿主对象不能锁定。
CanBeNonPhysical(HostObject)
判断指定的宿主对象是否可以被视为非物理模型。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
返回值:
- bool类型,true表示宿主对象可以被视为非物理模型,false表示宿主对象不能被视为非物理模型。
CanBeRenamed(HostObject)
判断指定的宿主对象是否可以重命名。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
返回值:
- bool类型,true表示宿主对象可以重命名,false表示宿主对象不能重命名。
CanBeTemporary(HostObject)
判断指定的宿主对象是否可以被视为临时对象。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
返回值:
- bool类型,true表示宿主对象可以被视为临时对象,false表示宿主对象不能被视为临时对象。
IsHostObject(Element)
判断指定的元素是否是宿主对象。
参数:
- Element: Autodesk.Revit.DB.Element类型,指定要检查的元素。
返回值:
- bool类型,true表示元素是宿主对象,false表示元素不是宿主对象。
IsTypeOfHostObject(ElementType)
判断指定的元素类型是否是宿主对象类型。
参数:
- ElementType: Type类型,指定要检查的元素类型。
返回值:
- bool类型,true表示元素类型是宿主对象类型,false表示元素类型不是宿主对象类型。
IsWorksharingSupported(HostObject)
判断指定的宿主对象是否支持协同工作。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
返回值:
- bool类型,true表示宿主对象支持协同工作,false表示宿主对象不支持协同工作。
IsValidFamilySymbolName(Document, String)
判断指定的族类型名称是否合法。
参数:
- Document: Autodesk.Revit.DB.Document类型,指定要检查的文档。
- String: String类型,指定要检查的族类型名称。
返回值:
- bool类型,true表示族类型名称合法,false表示族类型名称不合法。
IsValidPhaseCreated(HostObject, Phase)
判断指定的宿主对象指定的新建阶段是否合法。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
- Phase: Autodesk.Revit.DB.Phase类型,指定要检查的新建阶段。
返回值:
- bool类型,true表示新建阶段合法,false表示新建阶段不合法。
IsValidPhaseDemolished(HostObject, Phase)
判断指定的宿主对象指定的拆除阶段是否合法。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
- Phase: Autodesk.Revit.DB.Phase类型,指定要检查的拆除阶段。
返回值:
- bool类型,true表示拆除阶段合法,false表示拆除阶段不合法。
IsValidPhaseReplaced(HostObject, Phase, Phase)
判断指定的宿主对象指定的替换阶段是否合法。
参数:
- HostObject: Autodesk.Revit.DB.HostObject类型,指定要检查的宿主对象。
- Phase: Autodesk.Revit.DB.Phase类型,指定要替换的阶段。
- Phase: Autodesk.Revit.DB.Phase类型,指定替换后的阶段。
返回值:
- bool类型,true表示替换阶段合法,false表示替换阶段不合法。
IsValidType(ElementType)
判断指定的元素类型是否为合法的宿主对象类型。
参数:
- ElementType: Type类型,指定要检查的元素类型。
返回值:
- bool类型,true表示元素类型为合法的宿主对象类型,false表示元素类型不为合法的宿主对象类型。
结论
Autodesk.Revit.DB.HostObjectUtils提供了一系列用于宿主对象的检查和操作的工具方法,可以帮助开发人员更方便地处理宿主对象。具体而言,可以使用这些方法判断是否可以对宿主对象进行操作,或者创建宿主对象的副本等。同时,也可使用这些方法对元素的宿主对象属性进行检查。使用这些API可以大大简化宿主对象的开发。