M

RebarBarType.GetAutoCalculatedStaggerLength

Description:
Identifies if the stagger length is auto calculated for the specified Rebar Splice Type.

Remarks:
If it is auto calculated, stagger length value is computed based on the formula: stagger length multiplier (found in splice type) * lap length.

public bool GetAutoCalculatedStaggerLength(
	ElementId rebarSpliceTypeId
)

Public Function GetAutoCalculatedStaggerLength ( 
	rebarSpliceTypeId As ElementId
) As Boolean

public:
bool GetAutoCalculatedStaggerLength(
	ElementId^ rebarSpliceTypeId
)

member GetAutoCalculatedStaggerLength : 
        rebarSpliceTypeId : ElementId -> bool

ElementId

rebarSpliceTypeId

The Rebar Splice Type id. Interactions with Rebar Splice Types can be done with the functions in RebarSpliceTypeUtils.

Return Value Boolean Returns true if the stagger length is auto calculated for the specified Rebar Bar Type and Rebar Splice Type, false otherwise.

ArgumentException

The rebarSpliceTypeId doesn't represent a valid Rebar Splice Type. It should be an ElementType of BuiltInCategory.OST_RebarSpliceType category.
ArgumentNullException

A non-optional argument was null