M

ItemFactoryBase.NewFamilyInstance

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

Remarks:
This method is used to place a family instance onto a level. 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.

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,
	Level level,
	StructuralType structuralType
)

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

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

member NewFamilyInstance : 
        location : XYZ * 
        symbol : FamilySymbol * 
        level : Level * 
        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.
Level

level

The level onto which the FamilyInstance is to be placed.
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 level does not exist in the given document.
ArgumentException

Thrown if The symbol is not active.