M

EnergyDataSettings.CheckGroundPlane

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

Overloads (2):

CheckGroundPlane

CheckGroundPlane(Document,ElementId)

CheckGroundPlane(ElementId)

public bool CheckGroundPlane(
	ElementId groundPlaneId
)

Public Function CheckGroundPlane ( 
	groundPlaneId As ElementId
) As Boolean

public:
bool CheckGroundPlane(
	ElementId^ groundPlaneId
)

member CheckGroundPlane : 
        groundPlaneId : ElementId -> bool

ElementId

groundPlaneId

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.