Creates a new hosted line load within the project.
Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since: 2023
Syntax
| C# |
|---|
|
| Visual Basic |
|---|
|
| Visual C++ |
|---|
|
Parameters
- document
- Type: Autodesk.Revit.DBDocument
Document to which new line load will be added.
- hostElemId
- Type: Autodesk.Revit.DBElementId
The analytical host element for the line Load.
- forceVector1
- Type: Autodesk.Revit.DBXYZ
The applied 3d force vector.
- momentVector1
- Type: Autodesk.Revit.DBXYZ
The applied 3d moment vector.
- symbol
- Type: Autodesk.Revit.DB.StructureLineLoadType
The symbol of the LineLoad. Set a null reference (Nothing in Visual Basic) to use default type.
Return Value
If successful, returns the newly created LineLoad, a null reference (Nothing in Visual Basic) otherwise.Exceptions
| Exception | Condition |
|---|---|
| Autodesk.Revit.ExceptionsArgumentException | The element hostElemId does not exist in the document -or- hostElemId is not permitted for this type of load. |
| Autodesk.Revit.ExceptionsArgumentNullException | A non-optional argument was null |
| Autodesk.Revit.ExceptionsArgumentsInconsistentException | Thrown when all force and moment vectors are equal zero. |
| Autodesk.Revit.ExceptionsInvalidOperationException | Thrown if type could not be set for newly created line load. |