M

ItemFactoryBase.NewFamilyInstance

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

Remarks:
This method is used to insert one family instance into another element, such as inserting a window into a wall. 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.

The host object must be one that supports insertion of instances otherwise this method will fail.

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 (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(
	XYZ location,
	FamilySymbol symbol,
	Element host,
	StructuralType structuralType
)

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

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

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

XYZ

location

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

symbol

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

host

The object into which the FamilyInstance is to be inserted, often known as the host.
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 symbol is not active.