M

LoadCase.Create(Document, String, ElementId, ElementId)

Description:
Creates a new LoadCase.

Remarks:
This method is designed to create LoadCase that is associated with user defined category.

Overloads (2):

Create

Create(Document,String,ElementId,ElementId)

Create(Document,String,ElementId,LoadCaseCategory)

public static LoadCase Create(
	Document document,
	string name,
	ElementId natureId,
	ElementId subcategoryId
)

Public Shared Function Create ( 
	document As Document,
	name As String,
	natureId As ElementId,
	subcategoryId As ElementId
) As LoadCase

public:
static LoadCase^ Create(
	Document^ document, 
	String^ name, 
	ElementId^ natureId, 
	ElementId^ subcategoryId
)

static member Create : 
        document : Document * 
        name : string * 
        natureId : ElementId * 
        subcategoryId : ElementId -> LoadCase

Document

document

The Document to which new load case element will be added.
String

name

The name of the load case.
ElementId

natureId

The load nature ID.
ElementId

subcategoryId

The load case subcategory ID. Could be one of predefined or user defined load case category. Built-in structural Load Cases (OST_LoadCases) subcategories are: OST_LoadCasesDead OST_LoadCasesLive OST_LoadCasesWind OST_LoadCasesSnow OST_LoadCasesRoofLive OST_LoadCasesAccidental OST_LoadCasesTemperature OST_LoadCasesSeismic

Return Value LoadCase The newly created load case element if successful, otherwise.

ArgumentException

The given name is not unique. -or- name cannot include prohibited characters, such as "{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~".
ArgumentNullException

A non-optional argument was null

Share a snippet Help the community

Loading…

LoadCase.Create(Document, String, ElementId, ElementId)

Syntax

Parameters

Exceptions

Community Snippets

Discussion … comments