•  

CreateElementInstance Method (Document, ElementId, ElementId, String, Transform)

Creates a DirectShape object and adds it to document.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:  2017

Syntax

C#
public static DirectShape CreateElementInstance(
	Document document,
	ElementId typeId,
	ElementId categoryId,
	string definitionId,
	Transform trf
)
Visual Basic
Public Shared Function CreateElementInstance ( _
	document As Document, _
	typeId As ElementId, _
	categoryId As ElementId, _
	definitionId As String, _
	trf As Transform _
) As DirectShape
Visual C++
public:
static DirectShape^ CreateElementInstance(
	Document^ document, 
	ElementId^ typeId, 
	ElementId^ categoryId, 
	String^ definitionId, 
	Transform^ trf
)

Parameters

document
Type: Autodesk.Revit.DBDocument
Document to which the created element will be added.
typeId
Type: Autodesk.Revit.DBElementId
Element id of a DirectShapeType element.
categoryId
Type: Autodesk.Revit.DBElementId
Id of the category assigned to this DirectShape. Must be a valid category id.
definitionId
Type: SystemString
Id of the shape definition that was created earlier and stored via DirectShapeLibrary.
trf
Type: Autodesk.Revit.DBTransform
Transform to be applied to the definition.

Return Value

The created DirectShape object.

Remarks

This function is included for convenience. It essentially combines CreateGeometryInstance and CreateElement. The shape stored in the element is either a reference or a copy of a definition shape that was created earlier. How the definitions are stored will determine whether an instance or a copy of the shape will be created. The intended use is to support a definition/instance pattern common in CAD formats - DWG blocks, STEP MAPPED_ITEM, IFC IfcMappedItem. Use DirectShapeLibrary class to store definitions prior to using them here.

Exceptions

ExceptionCondition
Autodesk.Revit.ExceptionsArgumentException Document document may not contain DirectShape or DirectShapeType objects. -or- Element id categoryId may not be used as a DirectShape category.
Autodesk.Revit.ExceptionsArgumentNullException A non-optional argument was null

See Also