Class Stair
A builtin stair member.
Inherited Members
Namespace: DesignData.SDS2.Model
Assembly: DesignData.SDS2.Model.dll
Syntax
public sealed class Stair : Member
Constructors
Stair()
Declaration
public Stair()
Properties
ABMLength
The length of the stair in the ABM. If AutoABMLength is true, this property is read-only, and will throw an exception if trying to set it
Declaration
public double ABMLength { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
ABMNote
The ABM Note for this stair.
Declaration
public string ABMNote { get; set; }
Property Value
Type | Description |
---|---|
System.String |
AttachSupportsToTread
Applies only to field assembled stairs (ShopAssembled is false).
Declaration
public bool AttachSupportsToTread { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AutoNumberRisers
Controls if the number of risers will be automatically chosen.
Declaration
public AutomaticYesNo AutoNumberRisers { get; set; }
Property Value
Type | Description |
---|---|
AutomaticYesNo |
BottomRiserReturnLength
The positive/negative horizontal extension of the bottom riser return.
Declaration
public double BottomRiserReturnLength { get; set; }
Property Value
Type | Description |
---|---|
System.Double | And setback of '0' results in no return. A positive distance results in an extension inward, towards the stair. A negative distance results in an extension outward, away from the stair. |
BottomRiserSetback
The positive/negative vertical extension of the bottom riser.
Declaration
public double BottomRiserSetback { get; set; }
Property Value
Type | Description |
---|---|
System.Double | And setback of '0' results in the bottom riser's dimension being the same as the other risers in the stair. A positive distance extends the riser downward, toward the floor. A negative distance sets the riser back from the floor. |
BottomTreadSchedule
The top stair tread for this stair. Values either come from setup, or a user created custom stair tread.
Declaration
public StairTread BottomTreadSchedule { get; set; }
Property Value
Type | Description |
---|---|
StairTread |
CenterOffset
The positive/negative horizontal offset of the stair from the workline
Declaration
public double CenterOffset { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The offset from the workline. Positive offsets toward the near side of the workline. Negative offsets toward the far side of the workline. |
CNCMarks
Determines what CNC marks to automatically add to the inside faces of stair stringers to facilitate proper alignment of treads or tread supports.
Declaration
public StringerMark CNCMarks { get; set; }
Property Value
Type | Description |
---|---|
StringerMark |
ConnectionLeftFarSide
The connection between the left, far side stringer and its support
Declaration
public StairConnection ConnectionLeftFarSide { get; }
Property Value
Type | Description |
---|---|
StairConnection |
ConnectionLeftNearSide
The connection between the left, near side stringer and its support
Declaration
public StairConnection ConnectionLeftNearSide { get; }
Property Value
Type | Description |
---|---|
StairConnection |
ConnectionRightFarSide
The connection between the right, far side stringer and its support
Declaration
public StairConnection ConnectionRightFarSide { get; }
Property Value
Type | Description |
---|---|
StairConnection |
ConnectionRightNearSide
The connection between the right, near side stringer and its support
Declaration
public StairConnection ConnectionRightNearSide { get; }
Property Value
Type | Description |
---|---|
StairConnection |
DrawingScale
The scale at which the member detail of the stair is drawn.
Declaration
public double DrawingScale { get; set; }
Property Value
Type | Description |
---|---|
System.Double | If imperial units are being used, sets the number of inches on the stair detail that represent a foot in the shop or construction site. If metric units are used, sets the number of milimeters that represent 10 milimeters in the shop or construction site. |
InABM
Sets whether or not the stair is included in the ABM.
Declaration
public bool InABM { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IntermediateTreadSchedule
The intermediate stair tread for this stair. Values either come from setup, or a user created custom stair tread.
Declaration
public StairTread IntermediateTreadSchedule { get; set; }
Property Value
Type | Description |
---|---|
StairTread |
IsAutoABMLength
Sets if the ABM length is auto-generated. If this is false, length can be set using the ABMLength property
Declaration
public bool IsAutoABMLength { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
LeftFarSideStringer
The left, far side, stringer settings for this stair.
Declaration
public StairStringer LeftFarSideStringer { get; }
Property Value
Type | Description |
---|---|
StairStringer |
LeftNearSideStringer
The left, near side, stringer settings for this stair.
Declaration
public StairStringer LeftNearSideStringer { get; }
Property Value
Type | Description |
---|---|
StairStringer |
NosingDimension
The distance between the top flange of the stringer and the workline. Distance is measured perpendicular to the workline.
Declaration
public double NosingDimension { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
NumberRisers
Total number of risers for the stair tread.
Declaration
public int NumberRisers { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
OverrideFarSideMaterial
Sets if the default far side material is overwritten.
Declaration
public bool OverrideFarSideMaterial { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
RightFarSideStringer
The right, far side, stringer settings for this stair.
Declaration
public StairStringer RightFarSideStringer { get; }
Property Value
Type | Description |
---|---|
StairStringer |
RightNearSideStringer
The right, near side, stringer settings for this stair.
Declaration
public StairStringer RightNearSideStringer { get; }
Property Value
Type | Description |
---|---|
StairStringer |
RiserDimension
The height (rise) of the stair divided by the number of treads/risers
Declaration
public double RiserDimension { get; }
Property Value
Type | Description |
---|---|
System.Double |
ShopAssembled
Sets if the stair is shop assembled.
Declaration
public bool ShopAssembled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
StringerFarSideGrade
The far side stringer steel grade. If OverrideFarSideMaterial is false, this value is ignored.
Declaration
public SteelGrade StringerFarSideGrade { get; set; }
Property Value
Type | Description |
---|---|
SteelGrade |
StringerFarSideLength
Use far side stringer part length on BOM. This applies when the end condition for the far side stringer is 'Bolt to Floor'.
Declaration
public StringerLength StringerFarSideLength { get; set; }
Property Value
Type | Description |
---|---|
StringerLength |
StringerFarSideShape
The far side stringer shape. If OverrideFarSideMaterial is false, this value is ignored.
Declaration
public Shape StringerFarSideShape { get; set; }
Property Value
Type | Description |
---|---|
Shape | A channel, tube steel or plate material |
StringerFinish
The surface finish on the stair stringers.
Declaration
public SurfaceFinish StringerFinish { get; set; }
Property Value
Type | Description |
---|---|
SurfaceFinish |
StringerNearSideGrade
The near side stringer steel grade.
Declaration
public SteelGrade StringerNearSideGrade { get; set; }
Property Value
Type | Description |
---|---|
SteelGrade |
StringerNearSideLength
Use near side stringer part length on BOM. This applies when the end condition for the near side stringer is 'Bolt to Floor'.
Declaration
public StringerLength StringerNearSideLength { get; set; }
Property Value
Type | Description |
---|---|
StringerLength |
StringerNearSideShape
The near side stringer material. If OverrideFarSideMaterial is false, the far side material is also set to this material.
Declaration
public Shape StringerNearSideShape { get; set; }
Property Value
Type | Description |
---|---|
Shape | A channel, tube steel or plate material |
StringerSurfaceFinish
The surface finish on the stair stringers.
Declaration
[Obsolete("Model.Stair.StringerSurfaceFinish return type enum is deprecated. Use the StringerFinish property for the new type Setup.SurfaceFinish", false)]
public MaterialSurfaceFinish StringerSurfaceFinish { get; set; }
Property Value
Type | Description |
---|---|
MaterialSurfaceFinish |
TopTreadSchedule
The top stair tread for this stair. Values either come from setup, or a user created custom stair tread.
Declaration
public StairTread TopTreadSchedule { get; set; }
Property Value
Type | Description |
---|---|
StairTread |
TreadDimension
The horizontal length (run) of the stair divided by the number of treads/risers
Declaration
public double TreadDimension { get; }
Property Value
Type | Description |
---|---|
System.Double |
TreadFinish
Finish that will be applied to the tread surface.
Declaration
public SurfaceFinish TreadFinish { get; set; }
Property Value
Type | Description |
---|---|
SurfaceFinish |
TreadSurfaceFinish
Finish that will be applied to the tread surface.
Declaration
[Obsolete("Model.Stair.TreadSurfaceFinish return type enum is deprecated. Use the TreadFinish property for the new type Setup.SurfaceFinish", false)]
public MaterialSurfaceFinish TreadSurfaceFinish { get; set; }
Property Value
Type | Description |
---|---|
MaterialSurfaceFinish |
TreadWidth
Total width of the stair tread.
Declaration
public double TreadWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
UsePointToPointLength
Sets whether or not to use point to point in the ABM length calculation.
Declaration
public bool UsePointToPointLength { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | If True, will calculate length using point to point method. If false, the standard ABM length is used. |
Methods
Dispose(Boolean)
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing |