Share

Element Methods

The Element type exposes the following members.

Methods

 NameDescription
Public methodArePhasesModifiable Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
Public methodCanBeHiddenIndicates if the element can be hidden in the view.
Public methodCanBeLocked Identifies if the element can be locked.
Public methodCanDeleteSubelement Checks if given subelement can be removed from the element.
Public methodCanHaveTypeAssigned() Identifies if the element can have a type assigned.
Public methodStatic memberCanHaveTypeAssigned(Document, ICollection<ElementId>) 
Public methodChangeTypeId(ElementId) Changes the type of the element.
Public methodStatic memberChangeTypeId(Document, ICollection<ElementId>, ElementId) 
Public methodDeleteEntity Deletes the existing entity created by %schema% in the element
Public methodDeleteSubelement Removes a subelement from the element.
Public methodDeleteSubelements 
Public methodDispose 
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodEvaluateAllParameterValues Evaluates all the parameters' values of the element.
Public methodEvaluateParameterValues 
Public methodStatic memberGetChangeTypeAny Returns ChangeType associated with any change in an element.
Public methodStatic memberGetChangeTypeElementAddition Returns ChangeType associated with element addition
Public methodStatic memberGetChangeTypeElementDeletion Returns ChangeType associated with element deletion.
Public methodStatic memberGetChangeTypeGeometry Returns ChangeType associated with a change in the geometry of an element
Public methodStatic memberGetChangeTypeParameter(ElementId) Returns ChangeType associated with a change in a parameter's value
Public methodStatic memberGetChangeTypeParameter(Parameter) Returns ChangeType associated with a change in a parameter's value
Public methodGetDependentElements Get all elements that, from a logical point of view, are the children of this Element.
Public methodGetEntity Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
Public methodGetEntitySchemaGuids Returns the Schema guids of any Entities stored in this element.
Public methodGetExternalFileReference Gets information pertaining to the external file referenced by the element.
Public methodGetExternalResourceReference Gets the ExternalResourceReference associated with a specified external resource type.
Public methodGetExternalResourceReferenceExpanded Gets the collection of ExternalResourceReference associated with a specified external resource type.
Public methodGetExternalResourceReferences Gets the map of the external resource references referenced by the element.
Public methodGetExternalResourceReferencesExpanded Gets the expanded map of the external resource references referenced by the element.
Public methodGetGeneratingElementIds Returns the ids of the element(s) that generated the input geometry object.
Public methodGetGeometryObjectFromReference Retrieve one geometric primitive contained in the element given a reference.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetMaterialArea Gets the area of the material with the given id.
Public methodGetMaterialIds Gets the element ids of all materials present in the element.
Public methodGetMaterialVolume Gets the volume of the material with the given id.
Public methodGetMonitoredLinkElementIds Provides the link instance IDs when the element is monitoring.
Public methodGetMonitoredLocalElementIds Provides the local element IDs when the element is monitoring.
Public methodGetOrderedParameters Gets the parameters associated to the element in order.
Public methodGetParameterRetrieves a parameter from the element given identifier.
Public methodGetParameterFormatOptions Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
Public methodGetParametersRetrieves the parameters from the element via the given name.
Public methodGetPhaseStatus Gets the status of a given element in the input phase
Public methodGetSubelements Returns the collection of element subelements.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetTypeId Returns the identifier of this element's type.
Public methodGetValidTypes() Obtains a set of types that are valid for this element.
Public methodStatic memberGetValidTypes(Document, ICollection<ElementId>) 
Public methodHasPhases Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
Public methodIsCreatedPhaseOrderValid Returns true if createdPhaseId and demolishedPhaseId are in order.
Public methodIsDemolishedPhaseOrderValid Returns true if createdPhaseId and demolishedPhaseId are in order.
Public methodIsExternalFileReference Determines whether this Element represents an external file.
Public methodIsHiddenIdentifies if the element has been permanently hidden in the view.
Public methodIsMonitoringLinkElement Indicate whether an element is monitoring any elements in any linked models.
Public methodIsMonitoringLocalElement Indicate whether an element is monitoring other local elements.
Public methodIsPhaseCreatedValid Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
Public methodIsPhaseDemolishedValid Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
Public methodIsValidType(ElementId) Checks if given type is valid for this element.
Public methodStatic memberIsValidType(Document, ICollection<ElementId>, ElementId) 
Public methodLookupParameterAttempts to find a parameter on the element which has the given name.
Public methodRefersToExternalResourceReference Determines whether this Element uses external resources associated with a specified external resource type.
Public methodRefersToExternalResourceReferences Determines whether this Element uses external resources.
Public methodSetEntity Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)

See Also

Reference

Was this information helpful?