StairsRunCreateSpiralRun Method

public static StairsRun CreateSpiralRun(
	Document document,
	ElementId stairsId,
	XYZ center,
	double radius,
	double startAngle,
	double includedAngle,
	bool clockwise,
	StairsRunJustification justification
)

Public Shared Function CreateSpiralRun ( 
	document As Document,
	stairsId As ElementId,
	center As XYZ,
	radius As Double,
	startAngle As Double,
	includedAngle As Double,
	clockwise As Boolean,
	justification As StairsRunJustification
) As StairsRun

public:
static StairsRun^ CreateSpiralRun(
	Document^ document, 
	ElementId^ stairsId, 
	XYZ^ center, 
	double radius, 
	double startAngle, 
	double includedAngle, 
	bool clockwise, 
	StairsRunJustification justification
)

static member CreateSpiralRun : 
        document : Document * 
        stairsId : ElementId * 
        center : XYZ * 
        radius : float * 
        startAngle : float * 
        includedAngle : float * 
        clockwise : bool * 
        justification : StairsRunJustification -> StairsRun 

Parameters

document  Document

The document.

stairsId  ElementId

The stairs that the new stairs run will belong to.

center  XYZ

The center of the location arc of the spiral run. The Z coordinate of the center is the base elevation for the new run (in model coordinates). It must be greater than or equal to the stairs base elevation.

radius  Double

The radius of the location arc of the spiral run.

startAngle  Double

The start angle of the location arc of the spiral run. The angle's coordinate system is world coordinate system which always is XYZ.BasisX and XYZ.BasisY.

includedAngle  Double

The total angle covered by the spiral run. Must be a positive value (direction is determined by the clockwise flag).

clockwise  Boolean

True if the spiral run will be created along clockwise direction, False otherwise.

justification  StairsRunJustification

The location path justification of the new stairs run.

Return Value

Reference