ItemFactoryBaseNewFamilyInstance(XYZ, FamilySymbol, Level, StructuralType) Method

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 

Parameters

location  XYZ

The physical location where the instance is to be placed.

symbol  FamilySymbol

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

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.

Reference