Namespace: Autodesk.Revit.Creation Class: ItemFactoryBase

NewFamilyInstance

Method

Description:
Add a new family instance into the Autodesk Revit document, using an origin and a view where the instance should be placed.

Remarks:
This overload applies only to 2D family symbols (detail components, annotation symbols, titleblocks, etc.). 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.

Syntax

public FamilyInstance NewFamilyInstance(
	XYZ origin,
	FamilySymbol symbol,
	View specView
)

Public Function NewFamilyInstance ( _
	origin As XYZ, _
	symbol As FamilySymbol, _
	specView As View _
) As FamilyInstance

public:
FamilyInstance^ NewFamilyInstance(
	XYZ^ origin, 
	FamilySymbol^ symbol, 
	View^ specView
)

Parameters

Parameter	Type	Description
origin	Autodesk.Revit.DB.XYZ	origin of family instance. If created on a ViewPlan, the origin will be projected onto the ViewPlan.
symbol	Autodesk.Revit.DB.FamilySymbol	family symbol object that represents the type of the instance that is to be inserted.
specView	Autodesk.Revit.DB.View	2D view in which to place the family instance.

Return Value

Type	Description
Autodesk.Revit.Exceptions.ArgumentNullException	If creation was successful then an instance to the new object is returned.

Exceptions

Exception	Condition
Autodesk.Revit.Exceptions.ArgumentNullException	One or more required arguments wasnullNothingnullptra null reference (Nothingin Visual Basic)
Autodesk.Revit.Exceptions.ArgumentException	The input family PlacementType was not ViewBased, the input view was not 2D, Thrown if The symbol is not active. or instances of the input FamilySymbol are not permitted on a view of this type.