StairsRun
Description:
Represents a stairs run element in Autodesk Revit.
Represents a stairs run element in Autodesk Revit.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Architecture.StairsRun
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Architecture.StairsRun
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| ArePhasesModifiable() | Boolean | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) | Element |
| CanBeHidden(View) | Boolean | Indicates if the element can be hidden in the view. (Inherited from Element ) | Element |
| CanBeLocked() | Boolean | Identifies if the element can be locked. (Inherited from Element ) | Element |
| CanDeleteSubelement(Subelement) | Boolean | Checks if given subelement can be removed from the element. (Inherited from Element ) | Element |
| CanHaveTypeAssigned() | Boolean | Identifies if the element can have a type assigned. (Inherited from Element ) | Element |
| ChangeTypeId(ElementId) | ElementId | Changes the type of the element. (Inherited from Element ) | Element |
| CreateSketchedRun(Document, ElementId, Double, IList<Curve>, IList<Curve>, IList<Curve>) | StairsRun | Creates a sketched run in the project document by providing a group of boundary curves and riser curves. | |
| CreateSketchedRunWithSlopeData(Document, ElementId, Double, IList<SketchedStairsCurveData>, IList<Curve>, IList<Curve>) | StairsRun | Creates a sketched run in the project document by providing a group of boundary curves and riser curves, specifying slope type and height for boundary curves. | |
| CreateSpiralRun(Document, ElementId, XYZ, Double, Double, Double, Boolean, StairsRunJustification) | StairsRun | Creates a spiral run in the project document by providing the center, start angle and included angle. | |
| CreateStraightRun(Document, ElementId, Line, StairsRunJustification) | StairsRun | Creates a straight run in the project document. | |
| DeleteEntity(Schema) | Boolean | Deletes the existing entity created by %schema% in the element (Inherited from Element ) | Element |
| DeleteSubelement(Subelement) | Boolean | Removes a subelement from the element. (Inherited from Element ) | Element |
| DeleteSubelements(IList<Subelement>) | Boolean | Removes the subelements from the element. (Inherited from Element ) | Element |
| Dispose() | None | (Inherited from Element ) | Element |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| EvaluateAllParameterValues() | IList<EvaluatedParameter> | Evaluates all the parameters' values of the element. (Inherited from Element ) | Element |
| EvaluateParameterValues(ISet<ElementId>) | IList<EvaluatedParameter> | Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) | Element |
| GetAllSupports() | IList<ElementId> | Retrieves all supports hosted by the stair's run. | |
| GetConnections() | IList<StairsComponentConnection> | Returns information about the connections in which the stairs run participates. The stairs run may have no connection, or have at maximum two connections at the lower and upper ends. | |
| GetDependentElements(ElementFilter) | IList<ElementId> | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) | Element |
| GetEntity(Schema) | 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 |
| GetEntitySchemaGuids() | IList<Guid> | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) | Element |
| GetExternalFileReference() | ExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReference(ExternalResourceType) | ExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferenceExpanded(ExternalResourceType) | IList<ExternalResourceReference> | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferences() | IDictionary<ExternalResourceType,ExternalResourceReference> | Gets the map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReferencesExpanded() | ExternalResourceType | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetFootprintBoundary() | CurveLoop | Returns the run's boundary curves which are projected on the stairs base level. | |
| GetGeneratingElementIds(GeometryObject) | ICollection<ElementId> | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) | Element |
| GetGeometryObjectFromReference(Reference) | GeometryObject | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) | Element |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetLeftSupports() | IList<ElementId> | Retrieves all supports on the left side of run boundaries. | |
| GetMaterialArea(ElementId, Boolean) | Double | Gets the area of the material with the given id. (Inherited from Element ) | Element |
| GetMaterialIds(Boolean) | ICollection<ElementId> | Gets the element ids of all materials present in the element. (Inherited from Element ) | Element |
| GetMaterialVolume(ElementId) | Double | Gets the volume of the material with the given id. (Inherited from Element ) | Element |
| GetMonitoredLinkElementIds() | IList<ElementId> | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetMonitoredLocalElementIds() | IList<ElementId> | Provides the local element IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetNumberSystemReference(StairsNumberSystemReferenceOption) | Reference | Gets the number system reference corresponding to the given reference options. | |
| GetOrderedParameters() | IList<Parameter> | Gets the parameters associated to the element in order. (Inherited from Element ) | Element |
| GetParameter(ForgeTypeId) | Parameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) | Element |
| GetParameterFormatOptions(ElementId) | FormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) | Element |
| GetParameters(String) | IList<Parameter> | Retrieves the parameters from the element via the given name. (Inherited from Element ) | Element |
| GetPhaseStatus(ElementId) | ElementOnPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) | Element |
| GetRightSupports() | IList<ElementId> | Retrieves all supports on the right side of run boundaries. | |
| GetStairs() | Stairs | Returns the stairs to which the stairs run belongs. | |
| GetStairsPath() | CurveLoop | Returns the stairs path curves on the run. The curves are projected on base level of the stairs. | |
| GetSubelements() | IList<Subelement> | Returns the collection of element subelements. (Inherited from Element ) | Element |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| GetTypeId() | ElementId | Returns the identifier of this element's type. (Inherited from Element ) | Element |
| GetValidTypes() | ICollection<ElementId> | Obtains a set of types that are valid for this element. (Inherited from Element ) | Element |
| HasPhases() | Boolean | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) | Element |
| IsCreatedPhaseOrderValid(ElementId) | Boolean | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsDemolishedPhaseOrderValid(ElementId) | Boolean | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsExternalFileReference() | Boolean | Determines whether this Element represents an external file. (Inherited from Element ) | Element |
| IsHidden(View) | Boolean | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) | Element |
| IsMonitoringLinkElement() | Boolean | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) | Element |
| IsMonitoringLocalElement() | Boolean | Indicate whether an element is monitoring other local elements. (Inherited from Element ) | Element |
| IsPhaseCreatedValid(ElementId) | Boolean | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) | Element |
| IsPhaseDemolishedValid(ElementId) | Boolean | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) | Element |
| IsValidType(ElementId) | Boolean | Checks if given type is valid for this element. (Inherited from Element ) | Element |
| LookupParameter(String) | Parameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) | Element |
| RefersToExternalResourceReference(ExternalResourceType) | Boolean | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) | Element |
| RefersToExternalResourceReferences() | Boolean | Determines whether this Element uses external resources. (Inherited from Element ) | Element |
| 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 |
| SetLocationPathForSpiralRun(StairsRun, XYZ, Double, Double, Double, Boolean, StairsRunJustification) | Boolean | Set Location path for a spiral run. | |
| SetLocationPathForStraightRun(StairsRun, Line) | Boolean | Set location path for a straight run by giving a line. | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| ActualRisersNumber | int | The actual number of stairs risers in the stairs run. | |
| ActualRunWidth | double | Specifies the value of the tread width excluding the width of independent side supports. | |
| ActualTreadsNumber | int | The actual number of stairs treads in the stairs run. | |
| AssemblyInstanceId | ElementId | The id of the assembly instance to which the element belongs. (Inherited from Element ) | Element |
| BaseElevation | double | The base elevation of the stairs run. | |
| BeginsWithRiser | bool | True if the stairs run begins with a riser, false otherwise. | |
| BoundingBox | BoundingBoxXYZ | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) | Element |
| Category | Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) | Element |
| CreatedPhaseId | ElementId | Id of a Phase at which the Element was created. (Inherited from Element ) | Element |
| DemolishedPhaseId | ElementId | Id of a Phase at which the Element was demolished. (Inherited from Element ) | Element |
| DesignOption | DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) | Element |
| Document | Document | Returns the Document in which the Element resides. (Inherited from Element ) | Element |
| EndsWithRiser | bool | True if the stairs run ends with a riser, false otherwise. | |
| ExtensionBelowRiserBase | double | Specifies a value to extend/trim the run's first step against base elevation of the stairs if the stairs begins with a riser. | |
| ExtensionBelowTreadBase | double | Specifies a value to extend/trim the run's first step against base elevation of the stairs if the stairs begins with a tread. | |
| Geometry | GeometryElement | Retrieves the geometric representation of the element. (Inherited from Element ) | Element |
| GroupId | ElementId | The id of the group to which an element belongs. (Inherited from Element ) | Element |
| Height | double | The calculated height of the stairs run. | |
| Id | ElementId | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) | Element |
| IsModifiable | bool | Identifies if the element is modifiable. (Inherited from Element ) | Element |
| IsTransient | bool | Indicates whether an element is transient or permanent. (Inherited from Element ) | Element |
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) | Element |
| LevelId | ElementId | The id of the level associated with the element. (Inherited from Element ) | Element |
| Location | Location | This property is used to find the physical location of an element within a project. (Inherited from Element ) | Element |
| LocationLineJustification | StairsRunJustification | The position of the run relative to the Up-direction path used to create the run. | |
| Name | string | A human readable name for the Element. (Inherited from Element ) | Element |
| OwnerViewId | ElementId | The id of the view that owns the element. (Inherited from Element ) | Element |
| Parameter[BuiltInParameter] | Parameter | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) | Element |
| Parameter[Definition] | Parameter | Retrieves a parameter from the element based on its definition. (Inherited from Element ) | Element |
| Parameter[Guid] | Parameter | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) | Element |
| Parameters | ParameterSet | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| ParametersMap | ParameterMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| Pinned | bool | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) | Element |
| StairsRunStyle | StairsRunStyle | The style of the stairs run such as straight, winder, etc. | |
| TopElevation | double | The top elevation of the stairs run. | |
| UniqueId | string | A stable unique identifier for an element within the document. (Inherited from Element ) | Element |
| VersionGuid | Guid | Get the element version Guid. (Inherited from Element ) | Element |
| ViewSpecific | bool | Identifies if the element is owned by a view. (Inherited from Element ) | Element |
| WorksetId | WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) | Element |