Skip to content

BH.oM.Adapters.Revit.RevitFilePreview

Wrapper for Revit family file (.rfa) that stores basic information about it such as family category, familiy type names etc.

Class structure

Implemented interfaces and base types

The RevitFilePreview is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
Path string Path to the Revit family file wrapped by this object. -
CategoryName string Name of the Revit category, to which belongs the family wrapped by this object. -
FamilyName string Name of the Revit family wrapped by this object. -
FamilyTypeNames ReadOnlyCollection<string> Names of the family types contained within the Revit family wrapped by this object. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
BHoM_Guid Guid - -
Name string - -
Fragments FragmentSet - -
Tags HashSet<string> - -
CustomData Dictionary<string, object> - -

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Quantity Engine
Family Family Returns BHoM family wrapper based on RevitFilePreview. - Revit_Engine
OmniClass string Returns OmniClass assigned to Revit family represented by RevitFilePreview. - Revit_Engine
XDocument XDocument Retrieves XDocument from header of a Revit family file (.rfa) wrapped by RevitFilePreview. - Revit_Engine

Code and Schema

C# implementation

C#
public class RevitFilePreview : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject, BH.oM.Base.IImmutable

Assembly: Revit_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Revit_oM/RevitFilePreview.json"
}

The JSON Schema is available on github here: