2023 Members
Changes 4
M

ReferencePlane

Name Return Type Description Inherited From
M AddLeader(DatumEnds, View) Leader Adds a default Leader for the indicated end of the datum plane. This method does not apply to Reference planes (which do not support leaders). (Inherited from DatumPlane .) DatumPlane
M ArePhasesModifiable() bool Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element .) Element
M CanBeHidden(View) bool Indicates if the element can be hidden in the view. (Inherited from Element .) Element
M CanBeLocked() bool Identifies if the element can be locked. (Inherited from Element .) Element
M CanBeVisibleInView(View) bool Checks if the datum plane can be visible in the view. (Inherited from DatumPlane .) DatumPlane
M CanDeleteSubelement(Subelement) bool Checks if given subelement can be removed from the element. (Inherited from Element .) Element
M CanHaveTypeAssigned.() bool Identifies if the element can have a type assigned. (Inherited from Element .) Element
M ChangeTypeId(ElementId) ElementId Changes the type of the element. (Inherited from Element .) Element
M DeleteEntity(Schema) bool Deletes the existing entity created by %schema% in the element (Inherited from Element .) Element
M DeleteSubelement(Subelement) bool Removes a subelement from the element. (Inherited from Element .) Element
M DeleteSubelements(IList<Subelement>) bool Removes the subelements from the element. (Inherited from Element .) Element
M Dispose() None (Inherited from Element .) Element
M Equals None Determines whether the specified Object is equal to the current Object . (Inherited from Object .) Object .
M Flip() None Flips the orientation of the reference plane.
M GetCurvesInView(DatumExtentType, View) The curves. Gets a collection of curves representing the DatumPlane element in the given view. (Inherited from DatumPlane .) DatumPlane
M GetDatumExtentTypeInView(DatumEnds, View) The extent type. Identifies whether the curve representing the datum plane is displayed according to its actual 3d extents, or else according to a view specific setting. (Inherited from DatumPlane .) DatumPlane
M GetDependentElements(ElementFilter) IList<ElementId> Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element .) Element
M GetEntity(Schema) The returned Entity. Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. (Inherited from Element .) Element
M GetEntitySchemaGuids() IList<Guid> Returns the Schema guids of any Entities stored in this element. (Inherited from Element .) Element
M GetExternalFileReference() ExternalFileReference Gets information pertaining to the external file referenced by the element. (Inherited from Element .) Element
M GetExternalResourceReference(ExternalResourceType) ExternalResourceReference Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element .) Element
M GetExternalResourceReferenceExpanded(ExternalResourceType) IList<ExternalResourceReference> Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element .) Element
M GetExternalResourceReferences() IDictionary Gets the map of the external resource references referenced by the element. (Inherited from Element .) Element
M GetExternalResourceReferencesExpanded() IDictionary Gets the expanded map of the external resource references referenced by the element. (Inherited from Element .) Element
M GetGeneratingElementIds(GeometryObject) ICollection<ElementId> Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element .) Element
M GetGeometryObjectFromReference(Reference) GeometryObject Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element .) Element
M GetHashCode None Serves as a hash function for a particular type. (Inherited from Object .) Object .
M GetLeader(DatumEnds, View) Leader Gets a copy of the leader applied to the indicated end of the datum plane. This method does not apply to Reference planes (which do not support leaders). (Inherited from DatumPlane .) DatumPlane
M GetMaterialArea(ElementId, Boolean) double Gets the area of the material with the given id. (Inherited from Element .) Element
M GetMaterialIds(Boolean) ICollection<ElementId> Gets the element ids of all materials present in the element. (Inherited from Element .) Element
M GetMaterialVolume(ElementId) double Gets the volume of the material with the given id. (Inherited from Element .) Element
M GetMonitoredLinkElementIds() IList<ElementId> Provides the link instance IDs when the element is monitoring. (Inherited from Element .) Element
M GetMonitoredLocalElementIds() IList<ElementId> Provides the local element IDs when the element is monitoring. (Inherited from Element .) Element
M GetOrderedParameters() IList<Parameter> Gets the parameters associated to the element in order. (Inherited from Element .) Element
M GetParameter(ForgeTypeId) Parameter Retrieves a parameter from the element given identifier. (Inherited from Element .) Element
M GetParameterFormatOptions(ElementId) FormatOptions Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element .) Element
M GetParameters(String) IList<Parameter> Retrieves the parameters from the element via the given name. (Inherited from Element .) Element
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase (Inherited from Element .) Element
M GetPlane() Plane Returns the geometry plane to which the reference plane is assigned.
M GetPropagationViews(View) ISet<ElementId> Gets a list of candidate views which are parallel to the current view and to which the extents of the datum may be propagated. (Inherited from DatumPlane .) DatumPlane
M GetReference() Reference Returns the geometry reference of the reference plane.
M GetSubelements() IList<Subelement> Returns the collection of element subelements. (Inherited from Element .) Element
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. (Inherited from Element .) Element
M GetValidTypes.() ICollection<ElementId> Obtains a set of types that are valid for this element. (Inherited from Element .) Element
M HasBubbleInView(DatumEnds, View) bool Identifies if the DatumPlane has bubble or not. (Inherited from DatumPlane .) DatumPlane
M HasPhases() bool Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element .) Element
M HideBubbleInView(DatumEnds, View) None Hides the bubble in a view. This method does not apply to Reference planes. (Inherited from DatumPlane .) DatumPlane
M IsBubbleVisibleInView(DatumEnds, View) bool Identifies if the bubble is visible or not in a view. (Inherited from DatumPlane .) DatumPlane
M IsCreatedPhaseOrderValid(ElementId) bool Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .) Element
M IsCurveValidInView(DatumExtentType, View, Curve) bool Checks if the curve is valid to be as the extents for the datum plane in a view. The curve must be bound and coincident with the original one of the datum plane. (Inherited from DatumPlane .) DatumPlane
M IsDemolishedPhaseOrderValid(ElementId) bool Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .) Element
M IsExternalFileReference() bool Determines whether this Element represents an external file. (Inherited from Element .) Element
M IsHidden(View) bool Identifies if the element has been permanently hidden in the view. (Inherited from Element .) Element
M IsLeaderValid(DatumEnds, View, Leader) bool Identifies if the leader valid or not for this DatumPlane. This method does not apply to Reference planes (which do not support leaders). (Inherited from DatumPlane .) DatumPlane
M IsMonitoringLinkElement() bool Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element .) Element
M IsMonitoringLocalElement() bool Indicate whether an element is monitoring other local elements. (Inherited from Element .) Element
M IsPhaseCreatedValid(ElementId) bool Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element .) Element
M IsPhaseDemolishedValid(ElementId) bool Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element .) Element
M IsValidType(ElementId) bool Checks if given type is valid for this element. (Inherited from Element .) Element
M LookupParameter(String) nullNothingnullptr Attempts to find a parameter on the element which has the given name. (Inherited from Element .) Element
M Maximize3DExtents() None Computes the 3d extents of all model geometry and levels, and extends the 3d extents of this datum surface to include the model extents. (Inherited from DatumPlane .) DatumPlane
M PropagateToViews(View, ISet<ElementId>) None Propagates the extents applied to this datum in the view to the specified parallel views. (Inherited from DatumPlane .) DatumPlane
M RefersToExternalResourceReference(ExternalResourceType) bool Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element .) Element
M RefersToExternalResourceReferences() bool Determines whether this Element uses external resources. (Inherited from Element .) Element
M SetCurveInView(DatumExtentType, View, Curve) None Sets the extents to match the curve. (Inherited from DatumPlane .) DatumPlane
M SetDatumExtentType(DatumEnds, View, DatumExtentType) None Sets whether the curve representing the datum plane is displayed according to its 3d extents, or else according to a view specific setting. (Inherited from DatumPlane .) DatumPlane
M SetEntity(Entity) None Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element .) Element
M SetLeader(DatumEnds, View, Leader) None Sets the leader to the indicated end of the datum plane. This method does not apply to Reference planes (which do not support leaders). (Inherited from DatumPlane .) DatumPlane
M ShowBubbleInView(DatumEnds, View) None Shows the bubble in a view. This method does not apply to Reference planes. (Inherited from DatumPlane .) DatumPlane
M ToString None Returns a string that represents the current object. (Inherited from Object .) Object .
Name Return Type Description Inherited From
P AssemblyInstanceId ElementId The id of the assembly instance to which the element belongs. (Inherited from Element .) Element
P BoundingBox BoundingBoxXYZ Retrieves a box that circumscribes all geometry of the element. (Inherited from Element .) Element
P BubbleEnd XYZ The bubble end of the reference plane.
P Category Category Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element .) Element
P CreatedPhaseId ElementId Id of a Phase at which the Element was created. (Inherited from Element .) Element
P DemolishedPhaseId ElementId Id of a Phase at which the Element was demolished. (Inherited from Element .) Element
P DesignOption DesignOption Returns the design option to which the element belongs. (Inherited from Element .) Element
P Direction XYZ The direction of the reference plane.
P Document Document Returns the Document in which the Element resides. (Inherited from Element .) Element
P FreeEnd XYZ The free end of the reference plane.
P Geometry GeometryElement Retrieves the geometric representation of the element. (Inherited from Element .) Element
P GroupId ElementId The id of the group to which an element belongs. (Inherited from Element .) Element
P Id ElementId A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element .) Element
P IsModifiable bool Identifies if the element is modifiable. (Inherited from Element .) Element
P IsTransient bool Indicates whether an element is transient or permanent. (Inherited from Element .) Element
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element .) Element
P LevelId ElementId The id of the level associated with the element. (Inherited from Element .) Element
P Location Location This property is used to find the physical location of an element within a project. (Inherited from Element .) Element
P Name string The name property of the reference plane.
P Normal XYZ The normal vector of the reference plane.
P OwnerViewId ElementId The id of the view that owns the element. (Inherited from Element .) Element
P Parameter.Guid. Parameter Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element .) Element
P Parameter.BuiltInParameter. Parameter Retrieves a parameter from the element given a parameter id. (Inherited from Element .) Element
P Parameter.Definition. Parameter Retrieves a parameter from the element based on its definition. (Inherited from Element .) Element
P Parameters ParameterSet Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element .) Element
P ParametersMap ParameterMap Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element .) Element
P Pinned bool Identifies if the element has been pinned to prevent changes. (Inherited from Element .) Element
P UniqueId string A stable unique identifier for an element within the document. (Inherited from Element .) Element
P VersionGuid Guid Get the element version Guid. (Inherited from Element .) Element
P ViewSpecific bool Identifies if the element is owned by a view. (Inherited from Element .) Element
P WorksetId WorksetId Get Id of the Workset which owns the element. (Inherited from Element .) Element