Loads an entire family and all its types/symbols into the document and provides a reference
to the loaded family.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.1.0.0 (26.1.0.34)
Syntax
C#
public bool LoadFamily( string filename, IFamilyLoadOptions familyLoadOptions, out Family family )
Parameters
- filename String
- The fully qualified filename of the Family file, usually ending in .rfa.
- familyLoadOptions IFamilyLoadOptions
- The interface implementation to use when loading a family into the document.
- family Family%
- A reference to the family that was loaded if successful, otherwise Nothing.
Return Value
BooleanTrue if the entire family was loaded successfully into the project, otherwise False.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | Thrown when filename is nullptr or empty. |
| ArgumentNullException | Thrown when the input argument "familyLoadOptions" is nullptr. |
Remarks
Loading an entire family may take a considerable amount of time and memory. It is recommended that you use one of the LoadFamilySymbol() methods and only load those symbols that you need.