Skip to content

ViewPlan

Public Class

Represents floor plan, area plan, ceiling plan, and structural plan views in Revit.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.View
Autodesk.Revit.DB.ViewPlan

Namespace: Autodesk.Revit.DB

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

Syntax

public class ViewPlan : View

The ViewPlan type exposes the following members.

Properties

Name

Description


Public Property

Element id of Analysis Display Style associated with the view.
(Inherited from View)


Public Property

Indicates if analytical model categories are currently hidden in the view.
(Inherited from View)


Public Property

Indicates if annotation categories are currently hidden in the view.
(Inherited from View)


Public Property

The area scheme.


Public Property

Indicates if Coordination Model handles are currently hidden in the view.
(Inherited from View)


Public Property

Indicates if import categories are currently hidden in the view.
(Inherited from View)


Public Property

Indicates if model categories are currently hidden in the view.
(Inherited from View)


Public Property

Indicates if point clouds are currently hidden in the view.
(Inherited from View)


Public Property

The id of the assembly instance to which the element belongs.
(Inherited from Element)


Public Property

The Id of the assembly instance that owns the assembly view.
(Inherited from View)


Public Property
Code Example
BoundingBox

Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element)


Public Property

Test whether the view can be printed.
(Inherited from View)


Public Property
Category

Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element)


Public Property
Code Example
CreatedPhaseId

Id of a Phase at which the Element was created.
(Inherited from Element)


Public Property
CropBox

The Crop Box applied to the view, or an outline encompassing the crop region applied to the view.
(Inherited from View)


Public Property
CropBoxActive

Whether or not the Crop Box/Region is active for the view.
(Inherited from View)


Public Property

Whether or not the Crop Box/Region is visible for the view.
(Inherited from View)


Public Property
Code Example
DemolishedPhaseId

Id of a Phase at which the Element was demolished.
(Inherited from Element)


Public Property
Code Example
DesignOption

Returns the design option to which the element belongs.
(Inherited from Element)


Public Property

The detail level of this view.
(Inherited from View)


Public Property

The Discipline of the view.
(Inherited from View)


Public Property

The DisplayStyle of the view. Returns DisplayStyle.Wireframe if the view has no display style.
(Inherited from View)


Public Property
Document

Returns the Document in which the Element resides.
(Inherited from Element)


Public Property
GenLevel

The level for the view.
(Inherited from View)


Public Property
Code Example
Geometry

Retrieves the geometric representation of the element.
(Inherited from Element)


Public Property

The id of the group to which an element belongs.
(Inherited from Element)


Public Property
Code Example
Id

A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element)


Public Property

Indicates if the view is assembly view.
(Inherited from View)


Public Property
IsCallout

Indicates if the view is a callout view.
(Inherited from View)


Public Property
IsModifiable

Identifies if the element is modifiable.
(Inherited from Element)


Public Property

Test whether the view is a view template.
(Inherited from View)


Public Property
IsTransient

Indicates whether an element is transient or permanent.
(Inherited from Element)


Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element)


Public Property

The id of the level associated with the element.
(Inherited from Element)


Public Property
Code Example
Location

This property is used to find the physical location of an element within a project.
(Inherited from Element)


Public Property
Name

A human readable name for the Element.
(Inherited from Element)


Public Property
Origin

Returns the origin of the screen.
(Inherited from View)


Public Property
Outline

The bounds of the view in paper space (in feet).
(Inherited from View)


Public Property

The id of the view that owns the element.
(Inherited from Element)


Public Property
Code Example
Parameter.BuiltInParameter.

Retrieves a parameter from the element given a parameter id.
(Inherited from Element)


Public Property
Parameter.Definition.

Retrieves a parameter from the element based on its definition.
(Inherited from Element)


Public Property
Parameter.Guid.

Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element)


Public Property
Code Example
Parameters

Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element)


Public Property
ParametersMap

Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element)


Public Property

The visibility setting for parts in this view.
(Inherited from View)


Public Property
Pinned

Identifies if the element has been pinned to prevent changes.
(Inherited from Element)


Public Property

Indicates whether the Reveal Constraints mode is activated in the view.
(Inherited from View)


Public Property

The direction towards the right side of the screen.
(Inherited from View)


Public Property
Scale

The scale of the view.
(Inherited from View)


Public Property

The intesity of cast shadows - 0 = no shadows, 100 = black.
(Inherited from View)


Public Property
SketchPlane

The sketch plane assigned to the view for model curve creation.
(Inherited from View)


Public Property

The sun and shadow settings assigned to the view for shadow calculation and rendering.
(Inherited from View)


Public Property

The intensity of the simulated (directional) sunlight. 0 = no directional light; maximum value is 100.
(Inherited from View)


Public Property
TemporaryViewModes

Data of temporary view modes associated with this view.
(Inherited from View)


Public Property

The view title. This consists of the view name plus other modifiers, such as the view type, sheet number, area scheme, and/or assembly type, depending on the specifics of the view.
(Inherited from View)


Public Property
Code Example
UniqueId

A stable unique identifier for an element within the document.
(Inherited from Element)


Public Property

The direction towards the top of the screen.
(Inherited from View)


Public Property
VersionGuid

Get the element version Guid.
(Inherited from Element)


Public Property
ViewDirection

The direction towards the viewer.
(Inherited from View)


Public Property

Identifies if the element is owned by a view.
(Inherited from Element)


Public Property
ViewTemplateId

The id of the template view that controls this view’s parameters.
(Inherited from View)


Public Property
Code Example

The type of the view.
(Inherited from View)


Public Property
WorksetId

Get Id of the Workset which owns the element.
(Inherited from Element)


Methods

Name

Description


Public Method
AddFilter

Adds a filter to the view.
(Inherited from View)


Public Method

Identifies if this view allows display of Analysis results.
(Inherited from View)


Public Method
ApplyViewTemplateParameters

Applies to this view the parameters of the input view that are not controlled by the current view template.
(Inherited from View)


Public Method

Determines if Visibility/Graphics Overriddes can be applied to the view.
(Inherited from View)


Public Method
ArePhasesModifiable

Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element)


Public Method
CanApplyColorFillScheme

Checks if the id can be applied as the scheme id of specified category to this view.
(Inherited from View)


Public Method
CanBeHidden

Indicates if the element can be hidden in the view.
(Inherited from Element)


Public Method

Identifies if the element can be locked.
(Inherited from Element)


Public Method
CanCategoryBeHidden

Checks whether the category can be hidden in the view.
(Inherited from View)


Public Method

Check if category can be temporarily hidden in the view.
(Inherited from View)


Public Method

Checks if given subelement can be removed from the element.
(Inherited from Element)


Public Method

Indicates if Temporary View Properties mode can be applied for view in current state.
(Inherited from View)


Public Method
CanHaveTypeAssigned.

Identifies if the element can have a type assigned.
(Inherited from Element)


Public Method

Check if Detail Level can be modified.
(Inherited from View)


Public Method

Indicates if DisplayStyle can be modified.
(Inherited from View)


Public Method

Indicates if the View Discipline can be modified
(Inherited from View)


Public Method

Indicates if view can use Depth Cueing
(Inherited from View)


Public Method

Indicates if view can use temporary visibility modes
(Inherited from View)


Public Method

Identifies if this view can be duplicated.
(Inherited from View)


Public Method
ChangeTypeId(ElementId)

Changes the type of the element.
(Inherited from Element)


Public Method

Checks if the plan view range is valid.


Public Method

Convert all temporary hidden elements or categories to permanently hidden in view.
(Inherited from View)


Public Method
Code Example
ConvertToIndependent

Convert the dependent view to independent.
(Inherited from View)


Public Method
Static Member
Code Example

Creates a new ViewPlan.


Public Method
Static Member

Creates a new area plan ViewPlan.


Public Method

Creates a new view template instance from this view instance.
(Inherited from View)


Public Method

Deletes the existing entity created by %schema% in the element
(Inherited from Element)


Public Method
DeleteSubelement

Removes a subelement from the element.
(Inherited from Element)


Public Method
DeleteSubelements

Removes the subelements from the element.
(Inherited from Element)


Public Method
DisableTemporaryViewMode

Disables the specified temporary view mode.
(Inherited from View)


Public Method

(Inherited from Element)


Public Method
Code Example

Duplicates this view.
(Inherited from View)


Public Method

Enables Reveal Hidden elements mode.
(Inherited from View)


Public Method

Turns Temporary View Properties mode on or off. In this mode, any changes made to the view are temporary and will be discarded once the mode is disabled.
(Inherited from View)


Public Method

Equals

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


Public Method

Evaluates all the parameters’ values of the element.
(Inherited from Element)


Public Method

Evaluate the parameters’ values of the element on the given parameter ID set.
(Inherited from Element)


Public Method

Returns the current background set for the view.
(Inherited from View)


Public Method

Gets ID of the callout parent view.
(Inherited from View)


Public Method
GetCategoryHidden

Checks if elements of the given category are set to be invisible (hidden) in this view.
(Inherited from View)


Public Method

Gets graphic overrides for a category in view.
(Inherited from View)


Public Method

Returns id of the color fill scheme element applied to the view.
(Inherited from View)


Public Method

Returns an object for managing view crop region shape.
(Inherited from View)


Public Method
GetDependentElements

Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element)


Public Method

Get the ids of dependent views.
(Inherited from View)


Public Method

Returns the current depth cueing settings for the view.
(Inherited from View)


Public Method

Returns DirectContext3D handle overrides object for the view.
(Inherited from View)


Public Method

Gets graphic overrides for an element in the view.
(Inherited from View)


Public Method
GetEntity

Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
(Inherited from Element)


Public Method

Returns the Schema guids of any Entities stored in this element.
(Inherited from Element)


Public Method

Gets information pertaining to the external file referenced by the element.
(Inherited from Element)


Public Method
GetExternalResourceReference

Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)


Public Method
GetExternalResourceReferenceExpanded

Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)


Public Method
GetExternalResourceReferences

Gets the map of the external resource references referenced by the element.
(Inherited from Element)


Public Method
GetExternalResourceReferencesExpanded

Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element)


Public Method

Gets graphic overrides that a filter applies to the view.
(Inherited from View)


Public Method
GetFilters

Gets the filters applied to the view.
(Inherited from View)


Public Method

Gets the visibility of the elements associated with a filter.
(Inherited from View)


Public Method
Code Example
GetGeneratingElementIds

Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element)


Public Method
GetGeometryObjectFromReference

Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element)


Public Method

GetHashCode

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


Public Method
GetIsFilterEnabled

Identifies if the filter is enabled in this view.
(Inherited from View)


Public Method
Code Example

Gets the graphic overrides of a RevitLinkType or RevitLinkInstance in view.
(Inherited from View)


Public Method

Gets the area of the material with the given id.
(Inherited from Element)


Public Method
GetMaterialIds

Gets the element ids of all materials present in the element.
(Inherited from Element)


Public Method

Gets the volume of the material with the given id.
(Inherited from Element)


Public Method
GetModelToProjectionTransforms

Gets the transforms from the model space to the view projection space.
(Inherited from View)


Public Method

Provides the link instance IDs when the element is monitoring.
(Inherited from Element)


Public Method

Provides the local element IDs when the element is monitoring.
(Inherited from Element)


Public Method
GetNonControlledTemplateParameterIds

Returns a list of parameters that are not marked as included when this view is used as a template.
(Inherited from View)


Public Method

Gets the filters applied to the view in the order they are applied.
(Inherited from View)


Public Method
GetOrderedParameters

Gets the parameters associated to the element in order.
(Inherited from Element)


Public Method
GetParameter

Retrieves a parameter from the element given identifier.
(Inherited from Element)


Public Method

Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element)


Public Method
GetParameters

Retrieves the parameters from the element via the given name.
(Inherited from Element)


Public Method

Gets the status of a given element in the input phase
(Inherited from Element)


Public Method
GetPlacementOnSheetStatus

Determines if this view placed on a sheet completely or partially.
(Inherited from View)


Public Method

Returns point cloud overrides object for the view.
(Inherited from View)


Public Method
GetPrimaryViewId

Get the id of the primary view.
(Inherited from View)


Public Method

Returns element ids of all reference callouts in the view.
(Inherited from View)


Public Method

Returns element ids of all reference elevations in the view.
(Inherited from View)


Public Method

Returns element ids of all reference sections in the view.
(Inherited from View)


Public Method

Returns the current sketchy lines settings for the view.
(Inherited from View)


Public Method
GetSubelements

Returns the collection of element subelements.
(Inherited from Element)


Public Method

Returns a list of parameter ids that may be controlled when this view is assigned as a template.
(Inherited from View)


Public Method
GetTemporaryViewPropertiesId

When Temporary View Properties mode is in progress it provides view id that overrode settings for current view. Outside Temporary View Properties mode InvalidElementId will be returned.
(Inherited from View)


Public Method

When Temporary View Properties mode is in progress, name of applied template is returned. Outside Temporary View Properties mode, empty string will be returned.
(Inherited from View)


Public Method

GetType

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


Public Method
Code Example
GetTypeId

Returns the identifier of this element’s type.
(Inherited from Element)


Public Method

Returns the element id of the level that defines the bottom of the underlay range.


Public Method

Returns the underlay orientation of this view.


Public Method

Returns the element id of the level that defines the top of the underlay range.


Public Method

Obtains a set of types that are valid for this element.
(Inherited from Element)


Public Method

Returns the current view display model settings for the view.
(Inherited from View)


Public Method

Gets the view range.


Public Method
GetWorksetVisibility

Returns the visibility settings of a workset for this particular view.
(Inherited from View)


Public Method
GetWorksharingDisplayMode

Gets the current worksharing display mode for this view.
(Inherited from View)


Public Method

Check if the view has a Detail Level property
(Inherited from View)


Public Method

Indicates if view has a DisplayStyle property
(Inherited from View)


Public Method
HasPhases

Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element)


Public Method

Indicates if the view has a Discipline property
(Inherited from View)


Public Method
HasViewTransforms

Returns true if the view reports model space to view projection space transforms.
(Inherited from View)


Public Method

Hide the active work plane of the view.
(Inherited from View)


Public Method

Set multiple categories to be temporarily hidden in the view.
(Inherited from View)


Public Method

Set one category to be temporarily hidden in the view.
(Inherited from View)


Public Method
HideElements

Sets the elements to be hidden in the view.
(Inherited from View)


Public Method

Set multiple elements to be temporarily hidden in the view. To hide a group completely, you must also include all members of all groups and nested groups in your input.
(Inherited from View)


Public Method

Set one element to be temporarily hidden in the view. To hide a group completely, you must also include all members of all groups and nested groups in your input, therefore you should use the version of this method that accepts multiple element ids as input.
(Inherited from View)


Public Method
IsCategoryOverridable

Checks whether the category can have graphic overrides in this view.
(Inherited from View)


Public Method

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)


Public Method

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)


Public Method

Identifies if the input element is visible for the temporary view mode for this view.
(Inherited from View)


Public Method
IsExternalFileReference

Determines whether this Element represents an external file.
(Inherited from Element)


Public Method

Indicates if a filter is applied to the view.
(Inherited from View)


Public Method
IsHidden

Identifies if the element has been permanently hidden in the view.
(Inherited from Element)


Public Method

Returns true if the view is in a particular temporary view mode.
(Inherited from View)


Public Method

Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element)


Public Method

Indicate whether an element is monitoring other local elements.
(Inherited from Element)


Public Method

Set categories to be temporarily isolated in the view.
(Inherited from View)


Public Method

Set one category to be temporarily isolated in the view.
(Inherited from View)


Public Method

Set multiple elements to be temporarily isolated in the view. To isolate a group completely, you must also include all members of all groups and nested groups in your input.
(Inherited from View)


Public Method

Set one element to be temporarily isolated in the view. To isolate a group completely, you must also include all members of all groups and nested groups in your input, therefore you should use the version of this method that accepts multiple element ids as input.
(Inherited from View)


Public Method
IsPhaseCreatedValid

Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element)


Public Method
IsPhaseDemolishedValid

Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element)


Public Method

Indicates if the view is temporarily hiding or isolating elements or categories.
(Inherited from View)


Public Method

Returns true when Temporary View Properties mode is in progress, false otherwise.
(Inherited from View)


Public Method
IsValidType(ElementId)

Checks if given type is valid for this element.
(Inherited from Element)


Public Method

Verifies that the view represented by templateId can be set as the controlling view template for this view.
(Inherited from View)


Public Method

Verifies that the view is valid for template creation.
(Inherited from View)


Public Method
IsWorksetVisible

Indicates whether the workset is visible in this view.
(Inherited from View)


Public Method
LookupParameter

Attempts to find a parameter on the element which has the given name.
(Inherited from Element)


Public Method

Print this view with the default view template and using the print setting of the current active document.
(Inherited from View)


Public Method

Print this view with the default view template, and either the view’s document’s print setting or the print setting of the current active document.
(Inherited from View)


Public Method

Print this view with the given view template and using the print setting of the current active document.
(Inherited from View)


Public Method

Print this view with the given view template, and either the view’s document’s print setting or the print setting of the current active document.
(Inherited from View)


Public Method

Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element)


Public Method
RefersToExternalResourceReferences

Determines whether this Element uses external resources.
(Inherited from Element)


Public Method
RemoveCalloutParent

Replaces callout parent ID with InvalidElementId.
(Inherited from View)


Public Method

Removes a filter from the view.
(Inherited from View)


Public Method
Code Example
RemoveLinkOverrides

Deletes the graphical link overrides in the current view.
(Inherited from View)


Public Method
RestoreCalloutParent

Restores callout parent ID to the original view ID if that view is still available.
(Inherited from View)


Public Method

Sets the background for the view. Background can only be set for 3d views and for Sections/Elevations.
(Inherited from View)


Public Method
SetCategoryHidden

Sets if elements of the given category will be visible in this view.
(Inherited from View)


Public Method

Sets graphic overrides for a category in view.
(Inherited from View)


Public Method
SetColorFillSchemeId

Applies color fill scheme to this view.
(Inherited from View)


Public Method

Sets the depth cueing settings for the view.
(Inherited from View)


Public Method

Sets graphic overrides for an element in the view.
(Inherited from View)


Public Method

Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element)


Public Method
Code Example
SetFilterOverrides

Sets the overrides associated with a filter.
(Inherited from View)


Public Method
SetFilterVisibility

Sets the visibility of the elements associated with a filter.
(Inherited from View)


Public Method
SetIsFilterEnabled

Sets the filter enabled flag.
(Inherited from View)


Public Method
Code Example

Sets the graphic overrides of a RevitLinkType or RevitLinkInstance in the view.
(Inherited from View)


Public Method
SetNonControlledTemplateParameterIds

Sets the parameters that will not be included when this view is used as a template.
(Inherited from View)


Public Method

Sets the sketchy lines settings for the view.
(Inherited from View)


Public Method
SetUnderlayBaseLevel

Sets the level whose elevation will determine the bottom of the underlay range. The elevation of the next highest level will be used to determine the top of the underlay range.


Public Method

Sets the underlay orientation for this view.


Public Method
Code Example

Sets the underlay base and underlay top to the specified levels.


Public Method

Sets the view display model settings for the view.
(Inherited from View)


Public Method

Sets the view range.


Public Method
SetWorksetVisibility

Sets visibility for a workset in this view.
(Inherited from View)


Public Method
Code Example
SetWorksharingDisplayMode

Sets the worksharing display mode for this view.
(Inherited from View)


Public Method
ShowActiveWorkPlane

Show the active work plane of the view.
(Inherited from View)


Public Method
SupportedColorFillCategoryIds

Returns collection of all category ids that correspond to elements that can potentially be colored in this view according to a color fill scheme. The set may be different depending on the view type.
(Inherited from View)


Public Method
SupportsRevealConstraints

Checks that the view can have the Reveal Constraints mode activated.
(Inherited from View)


Public Method
SupportsWorksharingDisplayMode

Checks whether this view supports the given worksharing display mode.
(Inherited from View)


Public Method

ToString

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


Public Method
UnhideElements

Sets the elements to be shown in the given view if they are currently hidden.
(Inherited from View)


Remarks

In a plan view, the model is viewed as if cut by the cut plane and viewed from above, looking down. In ceiling plan views and structural plan views which look up, the model is viewed as if cut by the cut plane, and viewed as if looking down at a mirror.