M

ItemFactoryBase.NewFamilyInstance

Description:
Inserts a new instance of a family onto a face of an existing element, using a location, reference direction, and a type/symbol.

Remarks:
Use this method to insert one family instance on a face of another element, using a point on the face and a vector to define the position and direction of the new symbol.

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.

The host object must support insertion of instances, otherwise this method will fail. If the instances fails to be created an exception may be thrown.

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: if the created family instance includes nested instances, the API framework will automatically regenerate the document during this method call.

Overloads (10):

NewFamilyInstance

NewFamilyInstance(Face,Line,FamilySymbol)

NewFamilyInstance(Face,XYZ,XYZ,FamilySymbol)

NewFamilyInstance(Line,FamilySymbol,View)

NewFamilyInstance(Reference,Line,FamilySymbol)

NewFamilyInstance(Reference,XYZ,XYZ,FamilySymbol)

NewFamilyInstance(XYZ,FamilySymbol,Element,StructuralType)

NewFamilyInstance(XYZ,FamilySymbol,Level,StructuralType)

NewFamilyInstance(XYZ,FamilySymbol,StructuralType)

NewFamilyInstance(XYZ,FamilySymbol,View)

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

public FamilyInstance NewFamilyInstance(
	Face face,
	XYZ location,
	XYZ referenceDirection,
	FamilySymbol symbol
)

Public Function NewFamilyInstance ( 
	face As Face,
	location As XYZ,
	referenceDirection As XYZ,
	symbol As FamilySymbol
) As FamilyInstance

public:
FamilyInstance^ NewFamilyInstance(
	Face^ face, 
	XYZ^ location, 
	XYZ^ referenceDirection, 
	FamilySymbol^ symbol
)

member NewFamilyInstance : 
        face : Face * 
        location : XYZ * 
        referenceDirection : XYZ * 
        symbol : FamilySymbol -> FamilyInstance

Face

face

A face of a geometry object.
XYZ

location

Point on the face where the instance is to be placed.
XYZ

referenceDirection

A vector that defines the direction of the family instance. Note that this direction defines the rotation of the instance on the face, and thus cannot be parallel to the face normal.
FamilySymbol

symbol

A FamilySymbol object that represents the type of the instance that is to be inserted. Note that this symbol must represent a family whose FamilyPlacementType is WorkPlaneBased.

Return Value FamilyInstance An instance of the new object if creation was successful, otherwise .

ArgumentNullException

Thrown when a non-optional argument was null.
ArgumentException

Thrown when the function cannot get the Reference from the face, or, when the Family cannot be placed as line-based on an input face reference, because its FamilyPlacementType is not WorkPlaneBased
ArgumentsInconsistentException

Thrown when reference direction is parallel to face normal at insertion point.
InvalidOperationException

Thrown when Revit is unable to place the family instance.
ArgumentException

Thrown if The symbol is not active.