AreaReinforcement.Create(Document, Element, XYZ, ElementId, ElementId, ElementId)
Method
Description:
Creates a new AreaReinforcement object based on a host boundary.
Creates a new AreaReinforcement object based on a host boundary.
Syntax
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The document. |
hostElement | Element | The element that will host the AreaReinforcement. The host can be a Structural Floor, Structural Wall, Structural Slab, or a Part created from a structural layer belonging to one of those element types. |
majorDirection | XYZ | A vector to define the major direction of the AreaReinforcement. |
areaReinforcementTypeId | ElementId | The id of the AreaReinforcementType. |
rebarBarTypeId | ElementId | The id of the RebarBarType. |
rebarHookTypeId | ElementId | The id of the RebarHookType. If this parameter is InvalidElementId, it means to create a rebar with no hooks. |
Return Value
Type | Description |
---|---|
AreaReinforcement | The newly created AreaReinforcement. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | The element hostElement was not found in the given document. -or- the host Element is not a valid host for Area Reinforcement, Path Reinforcement, Fabric Area or Fabric Sheet. -or- areaReinforcementTypeId should refer to an AreaReinforcementType element. -or- rebarBarTypeId should refer to an RebarBarType element. -or- rebarHookTypeId should be invalid or refer to an RebarHookType element. |
ArgumentNullException | A non-optional argument was null |
ArgumentOutOfRangeException | majorDirection has zero length. |
ForbiddenForDynamicUpdateException | This method may not be called during dynamic update. |