PlanCircuit

Public Class

An object that represents an enclosed area in a plan view within the Autodesk Revit project.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.APIObject
Autodesk.Revit.DB.PlanCircuit

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class PlanCircuit : APIObject

The PlanCircuit type exposes the following members.

Properties

Name

Description

Public Property

Area

The enclosed area of the circuit.

Public Property
Code Example

IsReadOnly

Identifies if the object is read-only or modifiable.
(Inherited from APIObject)

Public Property

IsRoomLocated

Reports whether there is a room located in this circuit.

Public Property

SideNum

The number of sides in the circuit.

Methods

Name

Description

Public Method
Dispose

Causes the object to release immediately any resources it may be utilizing.
(Inherited from APIObject)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetPointInside

Returns a point inside the circuit.

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

Plan circuits are enclosed regions as seen on a plan view. They are used to determine the boundary extents of rooms based on the placement of walls. In the Autodesk Revit API, you can use plan circuits to create new rooms.