Creates a new hosted point load within the project.
Namespace: Autodesk.Revit.DB.StructureAssembly: RevitAPI (in RevitAPI.dll) Version: 23.0.0.0 (23.1.0.0)
Since: 2023
Syntax
C# |
---|
public static PointLoad Create( Document aDoc, ElementId hostElemId, AnalyticalElementSelector selector, XYZ forceVector, XYZ momentVector, PointLoadType symbol ) |
Visual Basic |
---|
Public Shared Function Create ( _ aDoc As Document, _ hostElemId As ElementId, _ selector As AnalyticalElementSelector, _ forceVector As XYZ, _ momentVector As XYZ, _ symbol As PointLoadType _ ) As PointLoad |
Visual C++ |
---|
public: static PointLoad^ Create( Document^ aDoc, ElementId^ hostElemId, AnalyticalElementSelector selector, XYZ^ forceVector, XYZ^ momentVector, PointLoadType^ symbol ) |
Parameters
- aDoc
- Type: Autodesk.Revit.DB..::..Document
Document to which new point load will be added.
- hostElemId
- Type: Autodesk.Revit.DB..::..ElementId
The AnalyticalMember (Analytical Beam, Analytical Brace, Analytical Column) host element for the point Load.
- selector
- Type: Autodesk.Revit.DB.Structure..::..AnalyticalElementSelector
The start or end point of the Analytical stick element.
- forceVector
- Type: Autodesk.Revit.DB..::..XYZ
The applied 3d force vector.
- momentVector
- Type: Autodesk.Revit.DB..::..XYZ
The applied 3d moment vector.
- symbol
- Type: Autodesk.Revit.DB.Structure..::..PointLoadType
The symbol of the PointLoad. Set nullNothingnullptra null reference (Nothing in Visual Basic) to use default type.
Return Value
If successful, returns the newly created PointLoad, nullNothingnullptra null reference (Nothing in Visual Basic) otherwise.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentException | The element hostElemId does not exist in the document -or- hostElemId is not permitted for this type of load. |
Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was null |
Autodesk.Revit.Exceptions..::..ArgumentOutOfRangeException | A value passed for an enumeration argument is not a member of that enumeration |
Autodesk.Revit.Exceptions..::..ArgumentsInconsistentException | Thrown when force and moment vectors are equal zero. |
Autodesk.Revit.Exceptions..::..InvalidOperationException | Thrown if type could not be set for newly created point load. |