RebarSpliceUtils.SpliceRebar(Document, ElementId, RebarSpliceOptions, Line, XYZ) Method

RebarSpliceUtilsSpliceRebar(Document, ElementId, RebarSpliceOptions, Line, XYZ) Method

Splice a rebar with a line.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.0.4.0 (26.0.4.0)
Syntax
public static IList<ElementId> SpliceRebar(
	Document document,
	ElementId rebarIdToSplit,
	RebarSpliceOptions spliceOptions,
	Line line,
	XYZ linePlaneNormal
)
Public Shared Function SpliceRebar ( 
	document As Document,
	rebarIdToSplit As ElementId,
	spliceOptions As RebarSpliceOptions,
	line As Line,
	linePlaneNormal As XYZ
) As IList(Of ElementId)
public:
static IList<ElementId^>^ SpliceRebar(
	Document^ document, 
	ElementId^ rebarIdToSplit, 
	RebarSpliceOptions^ spliceOptions, 
	Line^ line, 
	XYZ^ linePlaneNormal
)
static member SpliceRebar : 
        document : Document * 
        rebarIdToSplit : ElementId * 
        spliceOptions : RebarSpliceOptions * 
        line : Line * 
        linePlaneNormal : XYZ -> IList<ElementId> 

Parameters

document  Document
The document
rebarIdToSplit  ElementId
Rebar id to split.
spliceOptions  RebarSpliceOptions
The rebar splice options.
line  Line
The line used for splice.
linePlaneNormal  XYZ
The normal of the plane of the line.

Return Value

IListElementId
Returns the ids of the rebars that are considered to be spliced.
Exceptions
ExceptionCondition
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
Remarks

If the provided linePlaneNormal 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.

See Also