•  

Create Method (Document, ElementId, XYZ, AreaLoadType)

Creates a new hosted area load within the project.

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since: 2023

Syntax

C# 
public static AreaLoad Create(
	Document document,
	ElementId hostElemId,
	XYZ forceVector,
	AreaLoadType symbol
)
Visual Basic 
Public Shared Function Create ( _
	document As Document, _
	hostElemId As ElementId, _
	forceVector As XYZ, _
	symbol As AreaLoadType _
) As AreaLoad
Visual C++ 
public:
static AreaLoad^ Create(
	Document^ document, 
	ElementId^ hostElemId, 
	XYZ^ forceVector, 
	AreaLoadType^ symbol
)

Parameters

document
Type: Autodesk.Revit.DB Document
Document to which new area load will be added.
hostElemId
Type: Autodesk.Revit.DB ElementId
The analytical surface host element id for the area Load.
forceVector
Type: Autodesk.Revit.DB XYZ
The force vector applied to the 1st reference point of the area load.
symbol
Type: Autodesk.Revit.DB.Structure AreaLoadType
The symbol of the AreaLoad. Set a null reference ( Nothing in Visual Basic) to use default type.

Return Value

If successful, returns an object of the newly created AreaLoad. a null reference ( Nothing in Visual Basic) is returned if the operation fails.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions 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.
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was null
Autodesk.Revit.Exceptions InvalidOperationException Thrown if type could not be set for newly created area load.

See Also