Namespace: Autodesk.Revit.DB Class: Document

Document.LoadFamily(Document, IFamilyLoadOptions)

Method

Description:
Loads the contents of this family document into another document.

Remarks:
If you are reloading an edited family back into the source document from which it was extracted, use this overload. This is because this overload allows you to respond to possible conflicts due to families already being present in the target document. The Revit API offers one automatic overload: RevitUIFamilyLoadOptions, which will show the same prompts to the user as seen during an interactive load.

Syntax

public Family LoadFamily(
	Document targetDocument,
	IFamilyLoadOptions familyLoadOptions
)

Public Function LoadFamily ( 
	targetDocument As Document,
	familyLoadOptions As IFamilyLoadOptions
) As Family

public:
Family^ LoadFamily(
	Document^ targetDocument, 
	IFamilyLoadOptions^ familyLoadOptions
)

member LoadFamily : 
        targetDocument : Document * 
        familyLoadOptions : IFamilyLoadOptions -> Family

Parameters

Parameter	Type	Description
targetDocument	Document	The target document which the family will be loaded into.
familyLoadOptions	IFamilyLoadOptions	The interface implementation to use when responding to conflicts during the load operation.

Return Value

Type	Description
Family	Reference of the family in the target document.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when the input argument-"targetDocument" or "familyLoadOptions"-is.
InvalidOperationException	Thrown when the current document is not a family document, or when the target document is modifiable (e.g. there is an uncommitted transaction) or doesn't support load of this kind of families (e.g. loading a model family to detail family is disallowed), or the load was cancelled due to a conflict and a False return from one of the interface methods, or this document is currently in a read-only state.
ForbiddenForDynamicUpdateException	Thrown if this method is called during dynamic update.