StairsRunCreateStraightRun Method

public static StairsRun CreateStraightRun(
	Document document,
	ElementId stairsId,
	Line locationPath,
	StairsRunJustification justification
)

Public Shared Function CreateStraightRun ( 
	document As Document,
	stairsId As ElementId,
	locationPath As Line,
	justification As StairsRunJustification
) As StairsRun

public:
static StairsRun^ CreateStraightRun(
	Document^ document, 
	ElementId^ stairsId, 
	Line^ locationPath, 
	StairsRunJustification justification
)

static member CreateStraightRun : 
        document : Document * 
        stairsId : ElementId * 
        locationPath : Line * 
        justification : StairsRunJustification -> StairsRun 

Parameters

document  Document

The document.

stairsId  ElementId

The stairs that the new stairs run will belong to.

locationPath  Line

The line for location path of the new stairs run. The line has following restriction:

• The line should be bound line which is parallel to the XY plane.
• The Z coordinate of the line is the base elevation for the new run (in model coordinates). It must be greater than or equal to the stairs base elevation.
• The number of created risers will be calculated by rounding the length of the location path to a multiple of the tread depth.

justification  StairsRunJustification

The location path justification of the new stairs run.

Return Value

Reference