Namespace: Autodesk.Revit.DB Class: Document

Document.LoadFamily(String, 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,
	out Family family
)

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

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

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

Examples

// Get the Revit library path as defined via the Options dialog - File Locations tab - Places button
string libraryPath = "";
application.Application.GetLibraryPaths().TryGetValue("Imperial Library", out libraryPath);

if (String.IsNullOrEmpty(libraryPath))
{
    libraryPath = "c:\\";   // If not have, use a default path.
}

// Allow the user to select a family file.
OpenFileDialog openFileDialog1 = new OpenFileDialog();
openFileDialog1.InitialDirectory = libraryPath;
openFileDialog1.Filter = "Family Files (*.rfa)|*.rfa";

// Load the family file using LoadFamily method and then give information.
if (DialogResult.OK == openFileDialog1.ShowDialog())
{
    Autodesk.Revit.DB.Family family = null;
    if (document.LoadFamily(openFileDialog1.FileName, out family))
    {
        String name = family.Name;
        Autodesk.Revit.UI.TaskDialog.Show("Revit","Family file has been loaded. Its name is " + name);
    }
    else
    {
        Autodesk.Revit.UI.TaskDialog.Show("Revit","Can't load the family file.");
    }
}

' Get the Revit library path as defined via the Options dialog - File Locations tab - Places button
Dim libraryPath As String = ""
application.Application.GetLibraryPaths().TryGetValue("Imperial Library", libraryPath)

If [String].IsNullOrEmpty(libraryPath) Then
    ' If not have, use a default path.
    libraryPath = "c:\"
End If

' Allow the user to select a family file.
Dim openFileDialog1 As New OpenFileDialog()
openFileDialog1.InitialDirectory = libraryPath
openFileDialog1.Filter = "Family Files (*.rfa)|*.rfa"

' Load the family file using LoadFamily method and then give information.
If DialogResult.OK = openFileDialog1.ShowDialog() Then
    Dim family As Autodesk.Revit.DB.Family = Nothing
    If document.LoadFamily(openFileDialog1.FileName, family) Then
        Dim name As [String] = family.Name
        UI.TaskDialog.Show("Revit", "Family file has been loaded. Its name is " & name)
    Else
        UI.TaskDialog.Show("Revit", "Can't load the family file.")
    End If
End If

Parameters

Parameter	Type	Description
filename	String	The fully qualified filename of the Family file, usually ending in .rfa.
family	Family	A reference to the family that was loaded if successful, otherwise <span class="keyword"><span data-languagespecifictext="cpp=nullptr\|vb=Nothing\|nu=null" id="LST21EF8C53_3"></span></span>.

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.