M

RebarSpliceUtils.SpliceRebar

Description:
Splice a Rebar with a line.

Remarks:

This method uses the view normal in case of a 2D view and the current workplane normal in case of a 3D view.

If the view normal is parallel with the bar plane normal the bounded line will be used to calculate the splice geometries where the bar will be split.

Otherwise, the line will be extended to exceed the bounding box of the bar.

Overloads (3):

SpliceRebar

SpliceRebar(Document,ElementId,RebarSpliceOptions,IList[RebarSpliceGeometry])

SpliceRebar(Document,ElementId,RebarSpliceOptions,Line,ElementId)

SpliceRebar(Document,ElementId,RebarSpliceOptions,Line,XYZ)

public static IList<ElementId> SpliceRebar(
	Document document,
	ElementId rebarIdToSplit,
	RebarSpliceOptions spliceOptions,
	Line line,
	ElementId viewId
)

Public Shared Function SpliceRebar ( 
	document As Document,
	rebarIdToSplit As ElementId,
	spliceOptions As RebarSpliceOptions,
	line As Line,
	viewId As ElementId
) As IList(Of ElementId)

public:
static IList<ElementId^>^ SpliceRebar(
	Document^ document, 
	ElementId^ rebarIdToSplit, 
	RebarSpliceOptions^ spliceOptions, 
	Line^ line, 
	ElementId^ viewId
)

static member SpliceRebar : 
        document : Document * 
        rebarIdToSplit : ElementId * 
        spliceOptions : RebarSpliceOptions * 
        line : Line * 
        viewId : ElementId -> IList<ElementId>

Document

document

The document
ElementId

rebarIdToSplit

Rebar id to split.
RebarSpliceOptions

spliceOptions

The rebar splice options.
Line

line

The line used for splice.
ElementId

viewId

Based on the view it will be determined the plane of the line.

Return Value IList<ElementId> Returns the ids of the rebars that are considered to be spliced.

ArgumentException

Free Form Rebars, or Shape Driven Rebars that are Multiplanar or have a shape that whose definition is RebarShapeDefinitionByArc can't be spliced. Also, if the Rebar is member of a Group it cannot be spliced. -or- The rebar cannot be spliced with the provided line.
ArgumentNullException

A non-optional argument was null