RebarConstrainedHandle Class


Rebar Constrained Handle Class

A class representing a handle on a Rebar that can be joined to a reference, such as a host Element's surface or cover, another Rebar's handle or to a generic surface.
Inheritance Hierarchy
System Object
Autodesk.Revit.DB.Structure RebarConstrainedHandle

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 27.0.4.0 (27.0.4.0)
Syntax
public class RebarConstrainedHandle : IDisposable

The RebarConstrainedHandle type exposes the following members.

Properties
Name Description
Public property HandleBehavior Identifies the handle behavior.
Public property IsValidObject Specifies whether the .NET object represents a valid Revit entity.
Top
Methods
Name Description
Public method AllowsConstraintToCustomTarget Checks if the RebarConstrainedHandle allows constraint of [!:Autodesk::Revit::DB::Structure::RebarConstraintType::ToCustomTarget] type.
Public method AllowsConstraintToHostEdge Checks if the RebarConstrainedHandle allows constraint of [!:Autodesk::Revit::DB::Structure::RebarConstraintType::ToHostEdge] type.
Public method AllowsConstraintToHostEdgeCover Checks if the RebarConstrainedHandle allows constraint of [!:Autodesk::Revit::DB::Structure::RebarConstraintType::ToHostEdgeCover] type.
Public method AllowsConstraintToHostFaceOrToCover Checks if the RebarConstrainedHandle allows constraint of [!:Autodesk::Revit::DB::Structure::RebarConstraintType::FixedDistanceToHostFace] or [!:Autodesk::Revit::DB::Structure::RebarConstraintType::ToCover] type.
Public method AllowsConstraintToOtherRebarEdge Checks if the RebarConstrainedHandle allows constraint of [!:Autodesk::Revit::DB::Structure::RebarConstraintType::ToOtherRebar] type, where target is [!:Autodesk::Revit::DB::Structure::RebarConstraintType::TargetRebarConstraintType::Edge] .
Public method AllowsConstraintToSurface Checks if the RebarConstrainedHandle allows constraint of [!:Autodesk::Revit::DB::Structure::RebarConstraintType::ToSurface] type.
Public method AllowsDistanceToHostEdgeOrHostEdgeCover Checks if the RebarConstrainedHandle allows distance for a constraint of [!:Autodesk::Revit::DB::Structure::RebarConstraintType::ToHostEdge] or [!:Autodesk::Revit::DB::Structure::RebarConstraintType::ToHostEdgeCover] type.
Public method CanSetBehavior Checks if the input behavior can be set for this RebarConstrainedHandle.
Public method Dispose Releases all resources used by the RebarConstrainedHandle
Public method Equals Determines whether the specified object is equal to the current object.
(Inherited from Object )
Public method GetCustomHandleTag Returns the tag of the handle. The type of the handle should be 'CustomHandle'.
Public method GetEdgeNumber If the RebarConstrainedHandle's RebarHandleType is 'Edge', then this function will return the number of the edge that is driven by the handle.
Public method GetHandleName Gets the name of the handle.
Public method GetHandlePosition Gets the position of this handle as it is while editing constraints.
Public method GetHandleSurface Gets the surface of this handle.
Public method GetHandleType Returns the RebarHandleType of a RebarConstrainedHandle.
Public method GetHashCode Serves as the default hash function.
(Inherited from Object )
Public method GetPossibleHandleBehaviors Gets a list of possible handle behaviors for the current handle.
Public method GetRebarConstraintsManager Gets the RebarConstraintsManager that is associated with this handle.
Public method GetType Gets the Type of the current instance.
(Inherited from Object )
Public method IsCustomHandle Returns true if the RebarHandleType of the RebarConstrainedHandle is 'CustomHandle'.
Public method IsDraggable Checks that the RebarConstrainedHandle can be draggable in canvas (it has drag controls while editing constraints).
Public method IsEdgeHandle Returns true if the RebarHandleType of the RebarConstrainedHandle is 'Edge'.
Public method IsEqual Checks if the specified RebarConstrainedHandle is the same as 'this'.
Public method IsValid Checks that the RebarConstrainedHandle still has access to valid Rebar handle data and that its RebarConstraintsManager is still valid.
Public method Move Moves the handle with the specified vector.
Public method ToString Returns a string that represents the current object.
(Inherited from Object )
Top
Remarks

A rebar element's flexible geometry is controlled by several handles. For example, the shape of a shape driven rebar is controlled by a handle at each end of the bar and a handle each edge. Another handle is used to control the location of the plane in which the rebar lies. An additional handle controls the length of a set of rebar.

RebarConstrainedHandles can only be constructed internally by Revit. They are available to the API by querying a Rebar element's RebarConstraintsManager.

See Also
ArchiLabs

Stop fighting Revit automation.

Build repeatable BIM design and documentation workflows with scripts, data, and AI in one place, without wrestling brittle one-off automations.

Try ArchiLabs →