Namespace: Autodesk.Revit.DB Class: Document

Document.LoadFamily(String, IFamilyLoadOptions, Family)

Method

Description:
Loads an entire family and all its types/symbols into the document and provides a reference to the loaded family.

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.

Syntax

public bool LoadFamily(
	string filename,
	IFamilyLoadOptions familyLoadOptions,
	out Family family
)

Public Function LoadFamily ( 
	filename As String,
	familyLoadOptions As IFamilyLoadOptions,
	<OutAttribute> ByRef family As Family
) As Boolean

public:
bool LoadFamily(
	String^ filename, 
	IFamilyLoadOptions^ familyLoadOptions, 
	[OutAttribute] Family^% family
)

member LoadFamily : 
        filename : string * 
        familyLoadOptions : IFamilyLoadOptions * 
        family : Family byref -> bool

Parameters

Parameter	Type	Description
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

Type	Description
Boolean	True if the entire family was loaded successfully into the project, otherwise False.

Exceptions

Exception	Condition
ArgumentException	Thrown when filename isor empty.
ArgumentNullException	Thrown when the input argument "familyLoadOptions" is.