Skip to content

MultistoryStairs

Public Class

Represents a multistory stairs element in Autodesk Revit.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Architecture.MultistoryStairs

Namespace: Autodesk.Revit.DB.Architecture

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class MultistoryStairs : Element

The MultistoryStairs type exposes the following members.

Properties

Name

Description


Public Property
ActualTreadDepth

The actual depth of the stairs treads in the stairs, actual tread depth is equal to minimum tread depth by default.


Public Property

The id of the assembly instance to which the element belongs.
(Inherited from Element)


Public Property
Code Example
BoundingBox

Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element)


Public Property
Category

Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element)


Public Property
Code Example
CreatedPhaseId

Id of a Phase at which the Element was created.
(Inherited from Element)


Public Property
Code Example
DemolishedPhaseId

Id of a Phase at which the Element was demolished.
(Inherited from Element)


Public Property
Code Example
DesignOption

Returns the design option to which the element belongs.
(Inherited from Element)


Public Property
Document

Returns the Document in which the Element resides.
(Inherited from Element)


Public Property
Code Example
Geometry

Retrieves the geometric representation of the element.
(Inherited from Element)


Public Property

The id of the group to which an element belongs.
(Inherited from Element)


Public Property
Code Example
Id

A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element)


Public Property
IsModifiable

Identifies if the element is modifiable.
(Inherited from Element)


Public Property
IsTransient

Indicates whether an element is transient or permanent.
(Inherited from Element)


Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element)


Public Property

The id of the level associated with the element.
(Inherited from Element)


Public Property
Code Example
Location

This property is used to find the physical location of an element within a project.
(Inherited from Element)


Public Property
Name

A human readable name for the Element.
(Inherited from Element)


Public Property

The id of the view that owns the element.
(Inherited from Element)


Public Property
Code Example
Parameter.BuiltInParameter.

Retrieves a parameter from the element given a parameter id.
(Inherited from Element)


Public Property
Parameter.Definition.

Retrieves a parameter from the element based on its definition.
(Inherited from Element)


Public Property
Parameter.Guid.

Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element)


Public Property
Code Example
Parameters

Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element)


Public Property
ParametersMap

Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element)


Public Property
Pinned

Identifies if the element has been pinned to prevent changes.
(Inherited from Element)


Public Property

Id of the stair associated with the Reference Level for the multistory stairs. The standard stair is regarded as a definition to generate new stairs when extending multistory stairs to a different level height.


Public Property
Code Example
UniqueId

A stable unique identifier for an element within the document.
(Inherited from Element)


Public Property
VersionGuid

Get the element version Guid.
(Inherited from Element)


Public Property

Identifies if the element is owned by a view.
(Inherited from Element)


Public Property
WorksetId

Get Id of the Workset which owns the element.
(Inherited from Element)


Methods

Name

Description


Public Method
ArePhasesModifiable

Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element)


Public Method
CanBeHidden

Indicates if the element can be hidden in the view.
(Inherited from Element)


Public Method

Identifies if the element can be locked.
(Inherited from Element)


Public Method

Checks if the given level can be connected into multistory stairs. You cannot connect levels between standard stairs top and bottom or already connected.


Public Method

Checks if given subelement can be removed from the element.
(Inherited from Element)


Public Method

Checks if the given level can be disconnected from multistory stairs. You cannot disconnect the levels of standard stair (the stair associated with the Reference Level for the multistory stairs) or already disconnected.


Public Method
CanHaveTypeAssigned.

Identifies if the element can have a type assigned.
(Inherited from Element)


Public Method
ChangeTypeId(ElementId)

Changes the type of the element.
(Inherited from Element)


Public Method
ConnectLevels

Extends the multistory stairs by connecting input levels.


Public Method
Static Member

Creates a multistory stairs from an existing component-based stairs.


Public Method

Deletes the existing entity created by %schema% in the element
(Inherited from Element)


Public Method
DeleteSubelement

Removes a subelement from the element.
(Inherited from Element)


Public Method
DeleteSubelements

Removes the subelements from the element.
(Inherited from Element)


Public Method
DisconnectLevels

Shrinks the multistory stairs by disconnecting input levels.


Public Method

(Inherited from Element)


Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)


Public Method

Evaluates all the parameters’ values of the element.
(Inherited from Element)


Public Method

Evaluate the parameters’ values of the element on the given parameter ID set.
(Inherited from Element)


Public Method

Gets all connected level ids of this multistory stairs.


Public Method
GetAllStairsIds

Gets the ids of all the stairs in this multistory stairs.


Public Method
GetDependentElements

Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element)


Public Method
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)


Public Method

Returns the Schema guids of any Entities stored in this element.
(Inherited from Element)


Public Method

Gets information pertaining to the external file referenced by the element.
(Inherited from Element)


Public Method
GetExternalResourceReference

Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)


Public Method
GetExternalResourceReferenceExpanded

Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)


Public Method
GetExternalResourceReferences

Gets the map of the external resource references referenced by the element.
(Inherited from Element)


Public Method
GetExternalResourceReferencesExpanded

Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element)


Public Method
Code Example
GetGeneratingElementIds

Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element)


Public Method
GetGeometryObjectFromReference

Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element)


Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)


Public Method

Gets the area of the material with the given id.
(Inherited from Element)


Public Method
GetMaterialIds

Gets the element ids of all materials present in the element.
(Inherited from Element)


Public Method

Gets the volume of the material with the given id.
(Inherited from Element)


Public Method

Provides the link instance IDs when the element is monitoring.
(Inherited from Element)


Public Method

Provides the local element IDs when the element is monitoring.
(Inherited from Element)


Public Method
GetOrderedParameters

Gets the parameters associated to the element in order.
(Inherited from Element)


Public Method
GetParameter

Retrieves a parameter from the element given identifier.
(Inherited from Element)


Public Method

Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element)


Public Method
GetParameters

Retrieves the parameters from the element via the given name.
(Inherited from Element)


Public Method

Gets the status of a given element in the input phase
(Inherited from Element)


Public Method

Gets the individual stairs or stairs group on the given base level.


Public Method
GetStairsPlacementLevels

Gets all the levels the given stairs group placed on.


Public Method
GetSubelements

Returns the collection of element subelements.
(Inherited from Element)


Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)


Public Method
Code Example
GetTypeId

Returns the identifier of this element’s type.
(Inherited from Element)


Public Method

Obtains a set of types that are valid for this element.
(Inherited from Element)


Public Method
HasPhases

Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element)


Public Method
Static Member

Checks if the given stairs can be used to create a multistory stairs.


Public Method

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)


Public Method

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)


Public Method
IsExternalFileReference

Determines whether this Element represents an external file.
(Inherited from Element)


Public Method
IsHidden

Identifies if the element has been permanently hidden in the view.
(Inherited from Element)


Public Method

Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element)


Public Method

Indicate whether an element is monitoring other local elements.
(Inherited from Element)


Public Method
IsPhaseCreatedValid

Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element)


Public Method
IsPhaseDemolishedValid

Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element)


Public Method

Checks if a stair is pinned.


Public Method
IsValidType(ElementId)

Checks if given type is valid for this element.
(Inherited from Element)


Public Method
LookupParameter

Attempts to find a parameter on the element which has the given name.
(Inherited from Element)


Public Method
Pin

Restores an unpinned stairs element back into the group of stairs governed by level height.


Public Method

Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element)


Public Method
RefersToExternalResourceReferences

Determines whether this Element uses external resources.
(Inherited from Element)


Public Method

Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element)


Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)


Public Method
Unpin

Removes a particular story of the stairs (identified by its base level id) from a stairs group.


Remarks

A multistory stairs element may contain multiple stairs whose extents are governed by base and top levels. Use [M:Autodesk.Revit.DB.Architecture.MultistoryStairs.ConnectLevels(System.Collections.Generic.ISet`1{Autodesk.Revit.DB.ElementId})] and [M:Autodesk.Revit.DB.Architecture.MultistoryStairs.DisconnectLevels(System.Collections.Generic.ISet`1{Autodesk.Revit.DB.ElementId})] to add and remove connected levels to a multistory stairs element.

This element will contain one or more Stairs elements. These can be obtained via GetAllStairsIds. and

. Stairs elements are either a reference instance which is copied to each level covered by groups of identical stairs instances which share the same level height, or individual Stairs instances which are not connected to a group with the same level height. By default, when adding new levels to the multistory stair, new stairs will be added to the group (shown in the Revit user interface with a ‘Pin’ icon).

For groups of duplicate stairs at different levels, the instances can be found as Subelements of the Stairs element (see GetSubelements..

Stairs in a connected group can be edited together by modifying the associated Stairs instance. For specific floors that need special designs, stairs can be separated from a group by unpinning the element, changes made to this Stairs will not affect other any other instance in the element. Use Unpin(ElementId) for this.

You can add the stairs back into the group via Pin(ElementId) if needed. However, any changes made to the stair will be lost since the stair’s properties will be overridden by the group specifications.