Skip to content

Document.LoadFamilySymbol(String, String, FamilySymbol.)

Public Class

Loads only the specified family type/symbol from a family file into the document and provides a reference to the loaded family symbol.

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public bool LoadFamilySymbol(
string filename,
string name,
out FamilySymbol symbol
)

Parameters

filenameString

The fully qualified filename of the Family file, usually ending in .rfa.

nameString

The name of the type/symbol to be loaded, such as “W11x14”.

symbol FamilySymbol.

A reference to the family symbol that was loaded if successful, otherwise ..

Return Value

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

Exceptions

Exception

Condition


ArgumentException

Thrown when filename or name is . or empty.


Remarks

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