Share

EnergyDataSettings.CheckGroundPlane(Document, ElementId) Method

The ground plane should be an Element of type Level. This method checks to confirm that an ElementId is for a Level element.


Namespace: Autodesk.Revit.DB.Analysis
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)

Syntax

C#

public static bool CheckGroundPlane(
	Document ccda,
	ElementId groundPlaneId
)

Parameters

ccda  Document
The Document.
groundPlaneId  ElementId
The element id to be checked to confirm that it is suitable to be a ground plane (i.e., that it is a level) or that it is invalidElementId. Setting ground plane with invalidElementId will lead to the ground plane being "reset".

Return Value

Boolean
True if the input element is a level or invalidElementId, false otherwise.

Exceptions

ExceptionCondition
ArgumentNullException A non-optional argument was null

See Also

Reference

Was this information helpful?