PlanViewRange

Description:
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

public class PlanViewRange : IDisposable

Public Class PlanViewRange
	Implements IDisposable

public ref class PlanViewRange : IDisposable

type PlanViewRange = 
    class
        interface IDisposable
    end

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;
}

Private Function GetViewRangeTopClipPlane(doc As Document, view As View) As ElementId
    Dim topClipPlane As ElementId = ElementId.InvalidElementId

    If TypeOf view Is ViewPlan Then
        Dim viewPlan As ViewPlan = TryCast(view, ViewPlan)
        Dim viewRange As PlanViewRange = viewPlan.GetViewRange()

        topClipPlane = viewRange.GetLevelId(PlanViewPlane.TopClipPlane)
        Dim dOffset As Double = viewRange.GetOffset(PlanViewPlane.TopClipPlane)

        If topClipPlane.Value > 0 Then
            Dim levelAbove As Element = doc.GetElement(topClipPlane)
            TaskDialog.Show(view.Name, "Top Clip Plane: " + levelAbove.Name + vbCr & vbLf & "Top Offset: " + dOffset + " ft")
        End If
    End If

    Return topClipPlane
End Function

Name	Return Type	Description	Inherited From
M Dispose()	None	Releases all resources used by the PlanViewRange
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetLevelId(PlanViewPlane)	ElementId	Get the element id of the level for a View Depth plane
M GetOffset(PlanViewPlane)	Double	Get the offset value associated with a View Depth plane
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M SetLevelId(PlanViewPlane, ElementId)	None	Set the level for a View Depth plane
M SetOffset(PlanViewPlane, Double)	None	Set the offset value associated with a View Depth plane
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object

Name	Return Type	Description
P Current	ElementId	View range for the current plane
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.
P LevelAbove	ElementId	View range for the level above the specified plane
P LevelBelow	ElementId	View range for the level below the specified plane
P Unlimited	ElementId	View range is unlimited