AreaLoad.Create(Document, ElementId, XYZ, AreaLoadType)
Method
Description:
Creates a new hosted area load within the project.
Creates a new hosted area load within the project.
Syntax
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | Document to which new area load will be added. |
hostElemId | ElementId | The analytical surface host element id for the area Load. |
forceVector | XYZ | The force vector applied to the 1st reference point of the area load. |
symbol | AreaLoadType | The symbol of the AreaLoad. Set <span class="keyword"><span data-languagespecifictext="cpp=nullptr|vb=Nothing|nu=null" id="LSTBC49F122_1"></span></span> to use default type. |
Return Value
Type | Description |
---|---|
AreaLoad | If successful, returns an object of the newly created AreaLoad. is returned if the operation fails. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | The element hostElemId does not exist in the document -or- hostElemId is not permitted for this type of load. -or- Thrown when force vector is equal zero. |
ArgumentNullException | A non-optional argument was null |
InvalidOperationException | Thrown if type could not be set for newly created area load. |