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