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

Public Class

Splice a Rebar with a line.

Namespace: Autodesk.Revit.DB.Structure

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

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

Parameters

document Document

The document

rebarIdToSplit ElementId

Rebar id to split.

spliceOptions RebarSpliceOptions

The rebar splice options.

line Line

The line used for splice.

viewId ElementId

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.

Exceptions

Exception

Condition

---

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

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.