M

Document.LoadFamily

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.

Overloads (5):

LoadFamily

LoadFamily(Document)

LoadFamily(Document,IFamilyLoadOptions)

LoadFamily(String)

LoadFamily(String,Family)

LoadFamily(String,IFamilyLoadOptions,Family)

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

String

filename

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

familyLoadOptions

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 Boolean True if the entire family was loaded successfully into the project, otherwise False.

ArgumentException

Thrown when filename isor empty.
ArgumentNullException

Thrown when the input argument "familyLoadOptions" is.