GetConstraintCandidatesForHandle Method (RebarConstrainedHandle, ElementId)

For shape driven rebar returns all possible RebarConstraints belonging to references from the provided element that could be used for a specified RebarConstrainedHandle.

For free form rebar will return an empty list.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 23.0.0.0 (23.1.0.0)
Since:  2020.1

Syntax

C#
public IList<RebarConstraint> GetConstraintCandidatesForHandle(
	RebarConstrainedHandle handle,
	ElementId elementId
)
Visual Basic
Public Function GetConstraintCandidatesForHandle ( _
	handle As RebarConstrainedHandle, _
	elementId As ElementId _
) As IList(Of RebarConstraint)
Visual C++
public:
IList<RebarConstraint^>^ GetConstraintCandidatesForHandle(
	RebarConstrainedHandle^ handle, 
	ElementId^ elementId
)

Parameters

handle
Type: Autodesk.Revit.DB.Structure..::..RebarConstrainedHandle
The RebarConstrainedHandle for which constraint candidates are sought.
elementId
Type: Autodesk.Revit.DB..::..ElementId
The elementId ( host or rebar ) of the element in which the candidates are searched for.

Return Value

A collection of RebarConstraints

Remarks

Will throw exception if the provided elementId is not a valid constraint target.

Exceptions

ExceptionCondition
Autodesk.Revit.Exceptions..::..ArgumentException elementId is not a valid RebarConstraint target element.
Autodesk.Revit.Exceptions..::..ArgumentNullException A non-optional argument was null
Autodesk.Revit.Exceptions..::..InvalidOperationException The RebarConstraintsManager does not manage a valid Rebar element.

See Also

M:Autodesk.Revit.DB.Structure.RebarConstraintsManager.GetConstraintCandidatesForHandle(Autodesk.Revit.DB.Structure.RebarConstrainedHandle,Autodesk.Revit.DB.ElementId)