Rebar Constraints Manager Get Constraint Candidates For Handle(Rebar Constrained Handle, Reference) Method

For shape driven rebar returns all possible RebarConstraints that will constrain RebarConstrainedHandle to the provided reference.

For free form rebar will return an empty list.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public IList<RebarConstraint> GetConstraintCandidatesForHandle(
	RebarConstrainedHandle handle,
	Reference reference
)

Public Function GetConstraintCandidatesForHandle ( 
	handle As RebarConstrainedHandle,
	reference As Reference
) As IList(Of RebarConstraint)

public:
IList<RebarConstraint^>^ GetConstraintCandidatesForHandle(
	RebarConstrainedHandle^ handle, 
	Reference^ reference
)

member GetConstraintCandidatesForHandle : 
        handle : RebarConstrainedHandle * 
        reference : Reference -> IList<RebarConstraint>

handle RebarConstrainedHandle: The RebarConstrainedHandle for which constraint candidates are sought.
reference Reference: The reference you want to constrain to. It can be a reference to any host in the model or any bar from any host.

IList RebarConstraint
A collection of RebarConstraints

Exceptions

Exception	Condition
ArgumentException	reference is not from a valid RebarConstraint target element.
ArgumentNullException	A non-optional argument was null
InvalidOperationException	The RebarConstraintsManager does not manage a valid Rebar element.

Remarks

Will throw exception if the provided reference cannot be used to constrain the provided rebar handle.