LoadFamilySymbol Method (String, String)


Loads only a specified family type/symbol from a family file into the document.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 16.0.0.0 (16.0.0.0)

Syntax

C#
public bool LoadFamilySymbol(
	string filename,
	string name
)
Visual Basic
Public Function LoadFamilySymbol ( _
	filename As String, _
	name As String _
) As Boolean
Visual C++
public:
bool LoadFamilySymbol(
	String^ filename, 
	String^ name
)

Parameters

filename
Type: System String
The fully qualified filename of the Family file, usually ending in .rfa.
name
Type: System String
The name of the type/symbol to be loaded, such as "W11x14".

Return Value

True if the family type/symbol was loaded successfully into the project, otherwise False.

Remarks

This function supports loading of types/symbols stored in the family, or those available in the family Type Catalog file.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentException Thrown when filename or name is a null reference ( Nothing in Visual Basic) or empty.

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →