RVTDocs.com

AreaLoad.Create(Document, ElementId, IList<CurveLoop>, XYZ, AreaLoadType)

Method
Description:
Creates a new custom area load within the project.
Syntax
public static AreaLoad Create(
	Document document,
	ElementId hostElemId,
	IList<CurveLoop> loops,
	XYZ forceVector,
	AreaLoadType symbol
)
Parameters
Parameter Type Description
document Document Document to which new area load will be added.
hostElemId ElementId The analytical surface host element id for the area Load.
loops IList The loops that define geometry of the area load. The curve loop collection should contains a closed loops consisting of lines.
forceVector XYZ The force vector applied to the 1st reference point of the area load.
symbol AreaLoadType The symbol of the AreaLoad. Set <span class="keyword"><span data-languagespecifictext="cpp=nullptr|vb=Nothing|nu=null" id="LSTC6B0D8AD_5"></span></span> to use default type.
Return Value
Type Description
AreaLoad If successful, returns an object of the newly created AreaLoad. is returned if the operation fails.
Exceptions
Exception Condition
ArgumentException hostElemId is not permitted for this type of load. -or- One of the following requirements is not satisfied : - curve loops loops are not planar - curve loops loops are self-intersecting - curve loops loops contains zero length curves
ArgumentNullException A non-optional argument was null
ArgumentsInconsistentException Thrown if the host element id is a Curved Panel.
InvalidOperationException Thrown if type could not be set for newly created area load.