M

Zone.CreateAreaBasedLoad

Description:
Creates a new instance of an area based load and adds it to the document.

public static Zone CreateAreaBasedLoad(
	Document doc,
	string name,
	ElementId levelId,
	ElementId phaseId
)

Public Shared Function CreateAreaBasedLoad ( _
	doc As Document, _
	name As String, _
	levelId As ElementId, _
	phaseId As ElementId _
) As Zone

public:
static Zone^ CreateAreaBasedLoad(
	Document^ doc, 
	String^ name, 
	ElementId^ levelId, 
	ElementId^ phaseId
)

Autodesk.Revit.DB.Document

doc

The document where the element will be created and added.
String

name

The name of the area based load to be created.
Autodesk.Revit.DB.ElementId

levelId

The base level on which the area based load will be created.
Autodesk.Revit.DB.ElementId

phaseId

The associative phase on which the area based load is to exist.

Return Value Zone The newly created area based load.

Autodesk.Revit.Exceptions.ArgumentException

name cannot include prohibited characters, such as "{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~". -or- name is an empty string. -or- The ElementId levelId is not a Level. -or- The id does not represent a valid phase.
Autodesk.Revit.Exceptions.ArgumentNullException

A non-optional argument was null
Autodesk.Revit.Exceptions.InvalidOperationException

The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements).
Autodesk.Revit.Exceptions.ModificationForbiddenException

The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements). -or- The document is being loaded, or is in the midst of another sensitive process.
Autodesk.Revit.Exceptions.ModificationOutsideTransactionException

The document has no open transaction.