LoadCase.Create(Document, String, ElementId, ElementId)
Method
Description:
Creates a new LoadCase.
Creates a new LoadCase.
Remarks:
This method is designed to create LoadCase that is associated with user defined category.
This method is designed to create LoadCase that is associated with user defined category.
Syntax
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The Document to which new load case element will be added. |
name | String | The name of the load case. |
natureId | ElementId | The load nature ID. |
subcategoryId | ElementId | The load case subcategory ID. Could be one of predefined or user defined load case category. Built-in structural Load Cases (<a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCases</a>) subcategories are: <a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCasesDead</a><a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCasesLive</a><a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCasesWind</a><a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCasesSnow</a><a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCasesRoofLive</a><a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCasesAccidental</a><a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCasesTemperature</a><a href="ba1c5b30-242f-5fdc-8ea9-ec3b61e6e722.htm">OST_LoadCasesSeismic</a> |
Return Value
Type | Description |
---|---|
LoadCase | The newly created load case element if successful, otherwise. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | The given name is not unique. |
ArgumentNullException | A non-optional argument was null |