Element Class

Base class for most persistent data within a Revit document.

Inheritance Hierarchy

SystemObject
Autodesk.Revit.DBElement
More

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

C++

Copy

public class Element : IDisposable

Public Class Element
	Implements IDisposable

public ref class Element : IDisposable

type Element = 
    class
        interface IDisposable
    end

The Element type exposes the following members.

Properties

	Name	Description
	AssemblyInstanceId	The id of the assembly instance to which the element belongs.
	BoundingBox	Retrieves a box that circumscribes all geometry of the element.
	Category	Retrieves a Category object that represents the category or sub category in which the element resides.
	CreatedPhaseId	Id of a Phase at which the Element was created.
	DemolishedPhaseId	Id of a Phase at which the Element was demolished.
	DesignOption	Returns the design option to which the element belongs.
	Document	Returns the Document in which the Element resides.
	Geometry	Retrieves the geometric representation of the element.
	GroupId	The id of the group to which an element belongs.
	Id	A unique identifier for an Element in an Autodesk Revit project.
	IsModifiable	Identifies if the element is modifiable.
	IsTransient	Indicates whether an element is transient or permanent.
	IsValidObject	Specifies whether the .NET object represents a valid Revit entity.
	LevelId	The id of the level associated with the element.
	Location	This property is used to find the physical location of an element within a project.
	Name	A human readable name for the Element.
	OwnerViewId	The id of the view that owns the element.
	ParameterBuiltInParameter	Retrieves a parameter from the element given a parameter id.
	ParameterDefinition	Retrieves a parameter from the element based on its definition.
	ParameterGuid	Retrieves a parameter from the element given a GUID for a shared parameter.
	Parameters	Retrieves a set containing all of the parameters that are contained within the element.
	ParametersMap	Retrieves a map containing all of the parameters that are contained within the element.
	Pinned	Identifies if the element has been pinned to prevent changes.
	UniqueId	A stable unique identifier for an element within the document.
	VersionGuid	Get the element version Guid.
	ViewSpecific	Identifies if the element is owned by a view.
	WorksetId	Get Id of the Workset which owns the element.

Top

Methods

	Name	Description
	ArePhasesModifiable	Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
	CanBeHidden	Indicates if the element can be hidden in the view.
	CanBeLocked	Identifies if the element can be locked.
	CanDeleteSubelement	Checks if given subelement can be removed from the element.
	CanHaveTypeAssigned	Identifies if the element can have a type assigned.
	CanHaveTypeAssigned(Document, ICollectionElementId)	Checks if all elements in the set can have a type assigned.
	ChangeTypeId(ElementId)	Changes the type of the element.
	ChangeTypeId(Document, ICollectionElementId, ElementId)	Changes the type of all elements in the given set.
	DeleteEntity	Deletes the existing entity created by %schema% in the element
	DeleteSubelement	Removes a subelement from the element.
	DeleteSubelements	Removes the subelements from the element.
	Dispose	Releases all resources used by the Element
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	EvaluateAllParameterValues	Evaluates all the parameters' values of the element.
	EvaluateParameterValues	Evaluate the parameters' values of the element on the given parameter ID set.
	GetChangeTypeAny	Returns ChangeType associated with any change in an element.
	GetChangeTypeElementAddition	Returns ChangeType associated with element addition
	GetChangeTypeElementDeletion	Returns ChangeType associated with element deletion.
	GetChangeTypeGeometry	Returns ChangeType associated with a change in the geometry of an element
	GetChangeTypeParameter(ElementId)	Returns ChangeType associated with a change in a parameter's value
	GetChangeTypeParameter(Parameter)	Returns ChangeType associated with a change in a parameter's value
	GetDependentElements	Get all elements that, from a logical point of view, are the children of this Element.
	GetEntity	Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
	GetEntitySchemaGuids	Returns the Schema guids of any Entities stored in this element.
	GetExternalFileReference	Gets information pertaining to the external file referenced by the element.
	GetExternalResourceReference	Gets the ExternalResourceReference associated with a specified external resource type.
	GetExternalResourceReferenceExpanded	Gets the collection of ExternalResourceReference associated with a specified external resource type.
	GetExternalResourceReferences	Gets the map of the external resource references referenced by the element.
	GetExternalResourceReferencesExpanded	Gets the expanded map of the external resource references referenced by the element.
	GetGeneratingElementIds	Returns the ids of the element(s) that generated the input geometry object.
	GetGeometryObjectFromReference	Retrieve one geometric primitive contained in the element given a reference.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetMaterialArea	Gets the area of the material with the given id.
	GetMaterialIds	Gets the element ids of all materials present in the element.
	GetMaterialVolume	Gets the volume of the material with the given id.
	GetMonitoredLinkElementIds	Provides the link instance IDs when the element is monitoring.
	GetMonitoredLocalElementIds	Provides the local element IDs when the element is monitoring.
	GetOrderedParameters	Gets the parameters associated to the element in order.
	GetParameter	Retrieves a parameter from the element given identifier.
	GetParameterFormatOptions	Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
	GetParameters	Retrieves the parameters from the element via the given name.
	GetPhaseStatus	Gets the status of a given element in the input phase
	GetSubelements	Returns the collection of element subelements.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetTypeId	Returns the identifier of this element's type.
	GetValidTypes	Obtains a set of types that are valid for this element.
	GetValidTypes(Document, ICollectionElementId)	Obtains a set of types that are valid for all given elements.
	HasPhases	Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
	IsCreatedPhaseOrderValid	Returns true if createdPhaseId and demolishedPhaseId are in order.
	IsDemolishedPhaseOrderValid	Returns true if createdPhaseId and demolishedPhaseId are in order.
	IsExternalFileReference	Determines whether this Element represents an external file.
	IsHidden	Identifies if the element has been permanently hidden in the view.
	IsMonitoringLinkElement	Indicate whether an element is monitoring any elements in any linked models.
	IsMonitoringLocalElement	Indicate whether an element is monitoring other local elements.
	IsPhaseCreatedValid	Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
	IsPhaseDemolishedValid	Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
	IsValidType(ElementId)	Checks if given type is valid for this element.
	IsValidType(Document, ICollectionElementId, ElementId)	Checks if given type is valid for the set of elements.
	LookupParameter	Attempts to find a parameter on the element which has the given name.
	RefersToExternalResourceReference	Determines whether this Element uses external resources associated with a specified external resource type.
	RefersToExternalResourceReferences	Determines whether this Element uses external resources.
	SetEntity	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

The data in a Revit document consists primarily of a collection of elements. An element usually corresponds to a single component of a building or drawing, such as a wall, door, or dimension, but it can also be something more abstract, like a wall type or a view. Every element in a document has a unique ID, represented by the ElementId class.

Reference

Autodesk.Revit.DB Namespace

Inheritance Hierarchy