M

LineLoad.Create

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

Overloads (3):

Create

Create(Document,ElementId,Curve,XYZ,XYZ,LineLoadType)

Create(Document,ElementId,Int32,XYZ,XYZ,LineLoadType)

Create(Document,ElementId,XYZ,XYZ,LineLoadType)

public static LineLoad Create(
	Document document,
	ElementId hostElemId,
	XYZ forceVector1,
	XYZ momentVector1,
	LineLoadType symbol
)

Public Shared Function Create ( 
	document As Document,
	hostElemId As ElementId,
	forceVector1 As XYZ,
	momentVector1 As XYZ,
	symbol As LineLoadType
) As LineLoad

public:
static LineLoad^ Create(
	Document^ document, 
	ElementId^ hostElemId, 
	XYZ^ forceVector1, 
	XYZ^ momentVector1, 
	LineLoadType^ symbol
)

static member Create : 
        document : Document * 
        hostElemId : ElementId * 
        forceVector1 : XYZ * 
        momentVector1 : XYZ * 
        symbol : LineLoadType -> LineLoad

Document

document

Document to which new line load will be added.
ElementId

hostElemId

The analytical host element for the line Load.
XYZ

forceVector1

The applied 3d force vector.
XYZ

momentVector1

The applied 3d moment vector.
LineLoadType

symbol

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

Return Value LineLoad If successful, returns the newly created LineLoad, otherwise.

ArgumentException

The element hostElemId does not exist in the document -or- hostElemId is not permitted for this type of load.
ArgumentNullException

A non-optional argument was null
ArgumentsInconsistentException

Thrown when all force and moment vectors are equal zero.
InvalidOperationException

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