PlanViewRange

Public Class

This class represents the view range of a plan view or a plan region. It records the element ids of the levels which a plane is relative to and the offset of each plane from that level.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.PlanViewRange

Namespace: Autodesk.Revit.DB

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

Syntax

public class PlanViewRange : IDisposable

The PlanViewRange type exposes the following members.

Properties

Name

Description

---

Public Property
Static Member

Current

View range for the current plane

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Public Property
Static Member

LevelAbove

View range for the level above the specified plane

---

Public Property
Static Member

LevelBelow

View range for the level below the specified plane

---

Public Property
Static Member

Unlimited

View range is unlimited

---

Methods

Name

Description

---

Public Method

Dispose

Releases all resources used by the PlanViewRange

---

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

GetLevelId

Get the element id of the level for a View Depth plane

---

Public Method

GetOffset

Get the offset value associated with a View Depth plane

---

Public Method

GetType

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

---

Public Method

SetLevelId

Set the level for a View Depth plane

---

Public Method

SetOffset

Set the offset value associated with a View Depth plane

---

Public Method

ToString

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

---

Example

private ElementId GetViewRangeTopClipPlane(Document doc, View view)
{
    ElementId topClipPlane = ElementId.InvalidElementId;

    if (view is ViewPlan)
    {
        ViewPlan viewPlan = view as ViewPlan;
        PlanViewRange viewRange = viewPlan.GetViewRange();

        topClipPlane = viewRange.GetLevelId(PlanViewPlane.TopClipPlane);
        double dOffset = viewRange.GetOffset(PlanViewPlane.TopClipPlane);

        if (topClipPlane != ElementId.InvalidElementId)
        {
            Element levelAbove = doc.GetElement(topClipPlane);
            TaskDialog.Show(view.Name, "Top Clip Plane: " + levelAbove.Name + "\r\nTop Offset: " + dOffset + " ft");
        }
    }

    return topClipPlane;
}