M

Document.NewFamilyInstance

Description:
Inserts a new instance of a family into the document, using a location, type/symbol, the host element and a base level.

Remarks:
This form of NewFamilyInstance is the most commonly used in Autodesk Revit since there are a large number of elements that use levels, such as Walls, Columns etc. If the instance fails to be created an exception may be thrown.

The type/symbol that is used must be loaded into the document before this method is called. Families and their symbols can be loaded using the Document.LoadFamily or Document.LoadFamilySymbol methods.

All levels within the document can be found by iterating over the entire document and searching for objects of type Autodesk.Revit.Elements.Level.

Some Families, such as Beams, have more than one endpoint and are inserted in the same manner as single point instances. Once inserted these linear family instances can have their endpoints changed by using the instance's Element.Location property.

Note: ForbiddenForDynamicUpdateException might be thrown during a dynamic update if the inserted instance establishes a mutual dependency with another structure.

Note: if the created family instance includes nested instances, the API framework will automatically regenerate the document during this method call.

Overloads (2):

NewFamilyInstance

NewFamilyInstance(Curve,FamilySymbol,Level,StructuralType)

NewFamilyInstance(XYZ,FamilySymbol,Element,Level,StructuralType)

public FamilyInstance NewFamilyInstance(
	XYZ location,
	FamilySymbol symbol,
	Element host,
	Level level,
	StructuralType structuralType
)

Public Function NewFamilyInstance ( 
	location As XYZ,
	symbol As FamilySymbol,
	host As Element,
	level As Level,
	structuralType As StructuralType
) As FamilyInstance

public:
FamilyInstance^ NewFamilyInstance(
	XYZ^ location, 
	FamilySymbol^ symbol, 
	Element^ host, 
	Level^ level, 
	StructuralType structuralType
)

member NewFamilyInstance : 
        location : XYZ * 
        symbol : FamilySymbol * 
        host : Element * 
        level : Level * 
        structuralType : StructuralType -> FamilyInstance

XYZ

location

The physical location where the instance is to be placed on the specified level.
FamilySymbol

symbol

A FamilySymbol object that represents the type of the instance that is to be inserted.
Element

host

A host object into which the instance will be embedded
Level

level

A Level object that is used as the base level for the object.
StructuralType

structuralType

If structural then specify the type of the component.

Return Value FamilyInstance If creation was successful then an instance to the new object is returned, otherwise .

ArgumentException

Thrown if the family symbol does not exist in the given document.
ArgumentException

Thrown if the host does not exist in the given document.
ArgumentException

Thrown if the level does not exist in the given document.
ArgumentException

Thrown if The symbol is not active.