Sign in
2027 Members
Changes 0
M

Element Methods

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