| Revit 2018 API |
| DisplacementElement Members |
| DisplacementElement Class Methods Properties See Also |
The DisplacementElement type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | ArePhasesModifiable |
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element.) |
| CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element.) |
| CanBeLocked |
Identifies if the element can be locked.
(Inherited from Element.) |
 | CanCategoryBeDisplaced |
Indicates whether elements of the specified category are eligible as displaced elements.
|
| CanDeleteSubelement |
Checks if given subelement can be removed from the element.
(Inherited from Element.) |
| CanElementsBeAddedToDisplacementSet |
Indicates if these elements can be displaced by this DisplacementElement.
|
| CanElementsBeDisplaced(View, ICollection<(Of <<'(ElementId>)>>)) |
Indicates if elements can be assigned to a new DisplacementElement.
|
| CanElementsBeDisplaced(View, ICollection<(Of <<'(ElementId>)>>), ElementId%) |
Indicates if elements can be assigned to a new DisplacementElement.
|
| CanHaveAnalyticalModel |
Indicates whether the Element can have an Analytical Model.
(Inherited from Element.) |
| CanHaveTypeAssigned()()()() |
Identifies if the element can have a type assigned.
(Inherited from Element.) |
| ChangeTypeId(ElementId) |
Changes the type of the element.
(Inherited from Element.) |
| Create |
Creates a new DisplacementElement as a child of the specified parent DisplacementElement.
|
| DeleteEntity |
Deletes the existing entity created by %schema% in the element
(Inherited from Element.) |
| DeleteSubelement |
Removes a subelement from the element.
(Inherited from Element.) |
| DeleteSubelements |
Removes the subelements from the element.
(Inherited from Element.) |
| Dispose | (Inherited from Element.) |
| Equals | (Inherited from Object.) |
| GetAbsoluteDisplacement |
The absolute displacement applied to the displaced elements.
|
| GetAdditionalElementsToDisplace |
Identify a set of elements that potentially should be displaced along with a given element.
|
| GetAnalyticalModel |
Retrieves writeable Analytical Model for Element.
(Inherited from Element.) |
| GetAnalyticalModelId |
Retrieves the Element Id of the Analytical Model Element for this Element.
(Inherited from Element.) |
| GetChildren |
Returns a set of DisplacementElements which have this
DisplacementElement as a parent.
|
| GetDependentElements |
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element.) |
| GetDisplacedElementIds()()()() |
The ids of the elements affected by this DisplacementElement.
|
| GetDisplacedElementIds(View) |
Returns the element ids of all displaced elements in the specified view.
|
| GetDisplacedElementIdsFromAllChildren |
The element ids of elements displaced by this DisplacementElement and any
DisplacementElement which declare this one as parent.
|
| GetDisplacementElementId |
The element id of the DisplacementElement that includes the specified element.
|
| GetDisplacementElementIds |
The element ids of all DisplacementElements owned by the specified view.
|
| GetEntity |
Returns the existing entity corresponding to the Schema if it has been saved in the
Element, or an invalid entity otherwise.
(Inherited from Element.) |
| GetEntitySchemaGuids |
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element.) |
| GetExternalFileReference |
Gets information pertaining to the external file referenced
by the element.
(Inherited from Element.) |
| GetExternalResourceReference |
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.) |
| GetExternalResourceReferences |
Gets the full map of the external resource references referenced
by the element.
(Inherited from Element.) |
| GetGeneratingElementIds |
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element.) |
| GetGeometryObjectFromReference |
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetMaterialArea |
Gets the area of the material with the given id.
(Inherited from Element.) |
| GetMaterialIds |
Gets the element ids of all materials present in the element.
(Inherited from Element.) |
| GetMaterialVolume |
Gets the volume of the material with the given id.
(Inherited from Element.) |
| GetMonitoredLinkElementIds |
Provides the link instance IDs when the element is monitoring.
(Inherited from Element.) |
| GetMonitoredLocalElementIds |
Provides the local element IDs when the element is monitoring.
(Inherited from Element.) |
| GetOrderedParameters |
Gets the parameters associated to the element in order.
(Inherited from Element.) |
| GetParameterFormatOptions |
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element.) |
| GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element.) |
| GetPhaseStatus |
Gets the status of a given element in the input phase
(Inherited from Element.) |
| GetRelativeDisplacement |
The relative displacement applied to the displaced elements by this DisplacementElement.
|
| GetSubelements |
Returns the collection of element subelements.
(Inherited from Element.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetTypeId |
Returns the identifier of this element's type.
(Inherited from Element.) |
| GetValidTypes()()()() |
Obtains a set of types that are valid for this element.
(Inherited from Element.) |
| HasPhases |
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element.) |
| IsAllowedAsDisplacedElement |
Indicates if the specified element is allowed to be displaced.
|
| IsElementDisplacedInView |
Indicates if the specified element displaced in the specified View.
|
| IsExternalFileReference |
Determines whether this Element represents an external
file.
(Inherited from Element.) |
| IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element.) |
| IsMonitoringLinkElement |
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element.) |
| IsMonitoringLocalElement |
Indicate whether an element is monitoring other local elements.
(Inherited from Element.) |
| IsNotEmpty |
Validates that the input set of element ids is valid for a DisplacementElement.
|
| IsPhaseCreatedValid |
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element.) |
| IsPhaseDemolishedValid |
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element.) |
| IsValidAsParentInView |
Indicates whether the specified DisplacementElement can be used as a parent when
creating a DisplacementElement in the specified view.
|
| IsValidType(ElementId) |
Checks if given type is valid for this element.
(Inherited from Element.) |
| LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element.) |
| RefersToExternalResourceReference |
Determines whether this Element uses external resources associated with
a specified external resource type.
(Inherited from Element.) |
| RefersToExternalResourceReferences |
Determines whether this Element uses external resources.
(Inherited from Element.) |
| RemoveDisplacedElement |
Remove a displaced element from this DisplacementElement.
|
| ResetDisplacedElements |
Sets the translation of the DisplacementElement to (0, 0, 0).
The DisplacementElement continues to exist, but its elements are displayed in their actual location.
|
| SetDisplacedElementIds |
Sets the ids of the elements affected by this DisplacementElement.
|
| SetEntity |
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten.
(Inherited from Element.) |
| SetRelativeDisplacement |
Sets the relative displacement applied to the displaced elements by this DisplacementElement.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | AssemblyInstanceId |
The id of the assembly instance to which the element belongs.
(Inherited from Element.) |
| BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element.) |
| Category | Retrieves a Category object that represents the category or sub category in which the
element resides. (Inherited from Element.) |
| CreatedPhaseId |
Id of a Phase at which the Element was created.
(Inherited from Element.) |
| DemolishedPhaseId |
Id of a Phase at which the Element was demolished.
(Inherited from Element.) |
| DesignOption | Returns the design option to which the element belongs. (Inherited from Element.) |
| Document | Returns the Document in which the Element resides. (Inherited from Element.) |
| Geometry | Retrieves the geometric representation of the element. (Inherited from Element.) |
| GroupId |
The id of the group to which an element belongs.
(Inherited from Element.) |
| Id |
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element.) |
| IsTransient |
Indicates whether an element is transient or permanent.
(Inherited from Element.) |
| IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element.) |
| LevelId |
The id of the level associated with the element.
(Inherited from Element.) |
| Location | This property is used to find the physical location of an element within a project. (Inherited from Element.) |
| Name | A human readable name for the Element. (Inherited from Element.) |
| OwnerViewId |
The id of the view that owns the element.
(Inherited from Element.) |
| Parameter[([( Guid])]) | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element.) |
| Parameter[([( BuiltInParameter])]) | Retrieves a parameter from the element given a parameter id. (Inherited from Element.) |
| Parameter[([( Definition])]) | Retrieves a parameter from the element based on its definition. (Inherited from Element.) |
| Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element.) |
| ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element.) |
| ParentId |
The element id of the parent DisplacementElement. This DisplacementElement's relative transform
will be concatenated with the absolute transform of its parent.
|
| Pinned |
Identifies if the element has been pinned to prevent changes.
(Inherited from Element.) |
| UniqueId |
A stable unique identifier for an element within the document.
(Inherited from Element.) |
| ViewSpecific |
Identifies if the element is owned by a view.
(Inherited from Element.) |
| WorksetId |
Get Id of the Workset which owns the element.
(Inherited from Element.) |