M

AreaLoad.Create

Description:
Creates a new hosted area load within the project.

Overloads (3):

Create

Create(Document,ElementId,IList[CurveLoop],IList[XYZ],IList[Int32],IList[Int32],AreaLoadType)

Create(Document,ElementId,IList[CurveLoop],XYZ,AreaLoadType)

Create(Document,ElementId,XYZ,AreaLoadType)

public static AreaLoad Create(
	Document document,
	ElementId hostElemId,
	XYZ forceVector,
	AreaLoadType symbol
)

Public Shared Function Create ( 
	document As Document,
	hostElemId As ElementId,
	forceVector As XYZ,
	symbol As AreaLoadType
) As AreaLoad

public:
static AreaLoad^ Create(
	Document^ document, 
	ElementId^ hostElemId, 
	XYZ^ forceVector, 
	AreaLoadType^ symbol
)

static member Create : 
        document : Document * 
        hostElemId : ElementId * 
        forceVector : XYZ * 
        symbol : AreaLoadType -> AreaLoad

Document

document

Document to which new area load will be added.
ElementId

hostElemId

The analytical surface host element id for the area Load.
XYZ

forceVector

The force vector applied to the 1st reference point of the area load.
AreaLoadType

symbol

The symbol of the AreaLoad. Set null to use default type.

Return Value AreaLoad If successful, returns an object of the newly created AreaLoad. is returned if the operation fails.

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. -or- hostElemId is not a valid host for area load.
ArgumentNullException

A non-optional argument was null
InvalidOperationException

Thrown if type could not be set for newly created area load.