RebarFreeFormAccessorGetHookTypeIdAtIndex Method |
Gets the id of the RebarHookType that is applied to this Rebar at the bar with index barPositionIndex at the specified end.
Namespace: Autodesk.Revit.DB.StructureAssembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntaxpublic ElementId GetHookTypeIdAtIndex(
int barPositionIndex,
int end
)
Public Function GetHookTypeIdAtIndex (
barPositionIndex As Integer,
end As Integer
) As ElementId
public:
ElementId^ GetHookTypeIdAtIndex(
int barPositionIndex,
int end
)
member GetHookTypeIdAtIndex :
barPositionIndex : int *
end : int -> ElementId
Parameters
- barPositionIndex Int32
-
An index between 0 and (NumberOfBarPositions-1).
- end Int32
-
0 for the start hook, 1 for the end hook.
Return Value
ElementId
The id of a RebarHookType, or invalidElementId if the rebar has no hook at the specified end.
ExceptionsException | Condition |
---|
ArgumentOutOfRangeException |
end must be 0 or 1.
-or-
barPositionIndex is not in the range [ 0, NumberOfBarPositions-1 ].
|
RemarksIf this Rebar has Workshop Instructions set to Straight will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetHookTypeId(int end).
If this Rebar has Workshop Instructions set to Bent there are different cases:
- All bars are matched exactly with a shape. In this case will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetHookTypeId(int end).
- All bars are matched in reversed order with a shape. In this case will return the same value for all barPositionIndex between 0 and (NumberOfBarPositions-1). This value will be the same as Rebar.GetHookTypeId(int end).
- Some bars are matched in reversed order and the others are matched exactly with a shape. In this case for bars that are matched reversed will return the id of the RebarHookType at the opposite end. For the others bars will return the same as Rebar.GetHookTypeId(int end).
See Also