•  

DisplacementElement Members

The DisplacementElement type exposes the following members.

Methods

Name Description
Public method ArePhasesModifiable
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element .)
Public method CanBeHidden
Indicates if the element can be hidden in the view.
(Inherited from Element .)
Public method CanBeLocked
Identifies if the element can be locked.
(Inherited from Element .)
Public method Static member CanCategoryBeDisplaced
Indicates whether elements of the specified category are eligible as displaced elements.
Public method CanDeleteSubelement
Checks if given subelement can be removed from the element.
(Inherited from Element .)
Public method CanElementsBeAddedToDisplacementSet
Indicates if these elements can be displaced by this DisplacementElement.
Public method Static member CanElementsBeDisplaced(View, ICollection ElementId )
Indicates if elements can be assigned to a new DisplacementElement.
Public method Static member CanElementsBeDisplaced(View, ICollection ElementId , ElementId )
Indicates if elements can be assigned to a new DisplacementElement.
Public method CanHaveAnalyticalModel
Indicates whether the Element can have an Analytical Model.
(Inherited from Element .)
Public method CanHaveTypeAssigned
Identifies if the element can have a type assigned.
(Inherited from Element .)
Public method ChangeTypeId(ElementId)
Changes the type of the element.
(Inherited from Element .)
Public method Static member Create
Creates a new DisplacementElement as a child of the specified parent DisplacementElement.
Public method DeleteEntity
Deletes the existing entity created by %schema% in the element
(Inherited from Element .)
Public method DeleteSubelement
Removes a subelement from the element.
(Inherited from Element .)
Public method DeleteSubelements
Removes the subelements from the element.
(Inherited from Element .)
Public method Dispose (Inherited from Element .)
Public method Equals
Determines whether the specified Object is equal to the current Object .
(Inherited from Object .)
Public method GetAbsoluteDisplacement
The absolute displacement applied to the displaced elements.
Public method Static member GetAdditionalElementsToDisplace
Identify a set of elements that potentially should be displaced along with a given element.
Public method GetAnalyticalModel
Retrieves writeable Analytical Model for Element.
(Inherited from Element .)
Public method GetAnalyticalModelId
Retrieves the Element Id of the Analytical Model Element for this Element.
(Inherited from Element .)
Public method GetChildren
Returns a set of DisplacementElements which have this DisplacementElement as a parent.
Public method GetDependentElements
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element .)
Public method GetDisplacedElementIds
The ids of the elements affected by this DisplacementElement.
Public method Static member GetDisplacedElementIds(View)
Returns the element ids of all displaced elements in the specified view.
Public method GetDisplacedElementIdsFromAllChildren
The element ids of elements displaced by this DisplacementElement and any DisplacementElement which declare this one as parent.
Public method Static member GetDisplacementElementId
The element id of the DisplacementElement that includes the specified element.
Public method Static member GetDisplacementElementIds
The element ids of all DisplacementElements owned by the specified view.
Public method 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 .)
Public method GetEntitySchemaGuids
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element .)
Public method GetExternalFileReference
Gets information pertaining to the external file referenced by the element.
(Inherited from Element .)
Public method GetExternalResourceReference
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element .)
Public method GetExternalResourceReferences
Gets the full map of the external resource references referenced by the element.
(Inherited from Element .)
Public method GetGeneratingElementIds
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element .)
Public method GetGeometryObjectFromReference
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element .)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object .)
Public method GetMaterialArea
Gets the area of the material with the given id.
(Inherited from Element .)
Public method GetMaterialIds
Gets the element ids of all materials present in the element.
(Inherited from Element .)
Public method GetMaterialVolume
Gets the volume of the material with the given id.
(Inherited from Element .)
Public method GetMonitoredLinkElementIds
Provides the link instance IDs when the element is monitoring.
(Inherited from Element .)
Public method GetMonitoredLocalElementIds
Provides the local element IDs when the element is monitoring.
(Inherited from Element .)
Public method GetOrderedParameters
Gets the parameters associated to the element in order.
(Inherited from Element .)
Public method GetParameterFormatOptions
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element .)
Public method GetParameters
Retrieves the parameters from the element via the given name.
(Inherited from Element .)
Public method GetPhaseStatus
Gets the status of a given element in the input phase
(Inherited from Element .)
Public method GetRelativeDisplacement
The relative displacement applied to the displaced elements by this DisplacementElement.
Public method GetSubelements
Returns the collection of element subelements.
(Inherited from Element .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method GetTypeId
Returns the identifier of this element's type.
(Inherited from Element .)
Public method GetValidTypes
Obtains a set of types that are valid for this element.
(Inherited from Element .)
Public method HasPhases
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element .)
Public method Static member IsAllowedAsDisplacedElement
Indicates if the specified element is allowed to be displaced.
Public method Static member IsElementDisplacedInView
Indicates if the specified element displaced in the specified View.
Public method IsExternalFileReference
Determines whether this Element represents an external file.
(Inherited from Element .)
Public method IsHidden
Identifies if the element has been permanently hidden in the view.
(Inherited from Element .)
Public method IsMonitoringLinkElement
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element .)
Public method IsMonitoringLocalElement
Indicate whether an element is monitoring other local elements.
(Inherited from Element .)
Public method Static member IsNotEmpty
Validates that the input set of element ids is valid for a DisplacementElement.
Public method IsPhaseCreatedValid
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element .)
Public method IsPhaseDemolishedValid
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element .)
Public method Static member IsValidAsParentInView
Indicates whether the specified DisplacementElement can be used as a parent when creating a DisplacementElement in the specified view.
Public method IsValidType(ElementId)
Checks if given type is valid for this element.
(Inherited from Element .)
Public method LookupParameter
Attempts to find a parameter on the element which has the given name.
(Inherited from Element .)
Public method RefersToExternalResourceReference
Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element .)
Public method RefersToExternalResourceReferences
Determines whether this Element uses external resources.
(Inherited from Element .)
Public method RemoveDisplacedElement
Remove a displaced element from this DisplacementElement.
Public method 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.
Public method SetDisplacedElementIds
Sets the ids of the elements affected by this DisplacementElement.
Public method SetEntity
Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element .)
Public method SetRelativeDisplacement
Sets the relative displacement applied to the displaced elements by this DisplacementElement.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)

Properties

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

See Also