Creates a new unhosted area load with variable forces at the vertices within the project.
Namespace: Autodesk.Revit.Creation
Assembly: RevitAPI (in RevitAPI.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
C# |
---|
|
Visual Basic |
---|
|
Visual C++ |
---|
|
Parameters
- curvesArr
- Type: Autodesk.Revit.DB CurveArray
An array of curves that define the shape of the area load.
- refPntIdxs
- Type: System Int32
The indices of the curves in curvesArr that will be used to define the reference points for the load.
- ends
- Type: System Int32
Identifies which of the curve end points should be used for the reference points, for each member of refPntIdxs. The value should be 0 for the start point or 1 for the end point of the curve.
- force0
- Type: Autodesk.Revit.DB XYZ
The 3d area force applied to the first reference point.
- force1
- Type: Autodesk.Revit.DB XYZ
The 3d area force applied to the second reference point. Ignored if only one or two reference points are supplied.
- force2
- Type: Autodesk.Revit.DB XYZ
The 3d area force applied to the third reference point. Ignored if only one or two reference points are supplied.
- isReaction
- Type: System Boolean
Specifies if the load is a reaction load. The load cannot be modified if isReaction=True.
- symbol
- Type: Autodesk.Revit.DB.Structure AreaLoadType
The symbol of the AreaLoad.
Return Value
If successful, NewAreaLoad returns an object for the newly created AreaLoad. a null reference ( Nothing in Visual Basic) is returned if the operation fails.Remarks
The size of the refPntIdxs and ends arrays must be the same, and a maximum of 3 values is permitted.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions InvalidOperationException | If the product is not Revit Structure. |
Autodesk.Revit.Exceptions ArgumentException | Thrown if the area load symbol does not exist in the given document. |