RVTDocs.com

StairsRun

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