ViewPlan

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

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.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Element
    Autodesk.Revit.DB.View
      Autodesk.Revit.DB.ViewPlan

public class ViewPlan : View

Public Class ViewPlan _
	Inherits View

public ref class ViewPlan : public View

Name	Return Type	Description	Inherited From
M CheckPlanViewRangeValidity(PlanViewRange)	IList<PlanViewRangeError>	Checks if the plan view range is valid.
M CreateAreaPlan(Document, ElementId, ElementId)	ViewPlan	Creates a new area plan ViewPlan.
M Create(Document, ElementId, ElementId)	The new ViewPlan.	Creates a new ViewPlan.
M GetUnderlayBaseLevel()	ElementId	Returns the element id of the level that defines the bottom of the underlay range.
M GetUnderlayOrientation()	UnderlayOrientation	Returns the underlay orientation of this view.
M GetUnderlayTopLevel()	ElementId	Returns the element id of the level that defines the top of the underlay range.
M GetViewRange()	The view range.	Gets the view range.
M SetUnderlayBaseLevel(ElementId)	None	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.
M SetUnderlayOrientation(UnderlayOrientation)	None	Sets the underlay orientation for this view.
M SetUnderlayRange(ElementId, ElementId)	None	Sets the underlay base and underlay top to the specified levels.
M SetViewRange(PlanViewRange)	None	Sets the view range.
M ArePhasesModifiable()	bool	Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.	Element
M CanBeHidden(View)	bool	Indicates if the element can be hidden in the view.	Element
M CanBeLocked()	bool	Identifies if the element can be locked.	Element
M CanDeleteSubelement(Subelement)	bool	Checks if given subelement can be removed from the element.	Element
M CanHaveAnalyticalModel()	bool	Indicates whether the Element can have an Analytical Model.	Element
M CanHaveTypeAssigned()	bool	Identifies if the element can have a type assigned.	Element
M CanHaveTypeAssigned(Document, ICollection<ElementId>)	bool	Checks if all elements in the set can have a type assigned.	Element
M ChangeTypeId(Document, ICollection<ElementId>, ElementId)	IDictionary	Changes the type of all elements in the given set.	Element
M ChangeTypeId(ElementId)	ElementId	Changes the type of the element.	Element
M DeleteEntity(Schema)	bool	Deletes the existing entity created by %schema% in the element	Element
M DeleteSubelement(Subelement)	bool	Removes a subelement from the element.	Element
M DeleteSubelements(IList<Subelement>)	bool	Removes the subelements from the element.	Element
M Dispose()	None	Releases all resources used by the	Element
M GetAnalyticalModelId()	Element Id.	Retrieves the Element Id of the Analytical Model Element for this Element.	Element
M GetAnalyticalModel()	Writeable Analytical Model.	Retrieves writeable Analytical Model for Element.	Element
M GetChangeTypeAny()	ChangeType	Returns ChangeType associated with any change in an element.	Element
M GetChangeTypeElementAddition()	ChangeType	Returns ChangeType associated with element addition	Element
M GetChangeTypeElementDeletion()	ChangeType	Returns ChangeType associated with element deletion.	Element
M GetChangeTypeGeometry()	ChangeType	Returns ChangeType associated with a change in the geometry of an element	Element
M GetChangeTypeParameter(ElementId)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetChangeTypeParameter(Parameter)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetDependentElements(ElementFilter)	IList<ElementId>	Get all elements that, from a logical point of view, are the children of this Element.	Element
M GetEntity(Schema)	The returned Entity.	Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.	Element
M GetEntitySchemaGuids()	IList<Guid>	Returns the Schema guids of any Entities stored in this element.	Element
M GetExternalFileReference()	ExternalFileReference	Gets information pertaining to the external file referenced by the element.	Element
M GetExternalResourceReference(ExternalResourceType)	ExternalResourceReference	Gets the ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReferences()	IDictionary	Gets the full map of the external resource references referenced by the element.	Element
M GetGeneratingElementIds(GeometryObject)	ICollection<ElementId>	Returns the ids of the element(s) that generated the input geometry object.	Element
M GetGeometryObjectFromReference(Reference)	GeometryObject	Retrieve one geometric primitive contained in the element given a reference.	Element
M GetMaterialArea(ElementId, Boolean)	double	Gets the area of the material with the given id.	Element
M GetMaterialIds(Boolean)	ICollection<ElementId>	Gets the element ids of all materials present in the element.	Element
M GetMaterialVolume(ElementId)	double	Gets the volume of the material with the given id.	Element
M GetMonitoredLinkElementIds()	IList<ElementId>	Provides the link instance IDs when the element is monitoring.	Element
M GetMonitoredLocalElementIds()	IList<ElementId>	Provides the local element IDs when the element is monitoring.	Element
M GetOrderedParameters()	IList<Parameter>	Gets the parameters associated to the element in order.	Element
M GetParameterFormatOptions(ElementId)	FormatOptions	Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.	Element
M GetParameters(String)	IList<Parameter>	Retrieves the parameters from the element via the given name.	Element
M GetPhaseStatus(ElementId)	ElementOnPhaseStatus	Gets the status of a given element in the input phase	Element
M GetSubelements()	IList<Subelement>	Returns the collection of element subelements.	Element
M GetTypeId()	ElementId	Returns the identifier of this element's type.	Element
M GetValidTypes()	ICollection<ElementId>	Obtains a set of types that are valid for this element.	Element
M GetValidTypes(Document, ICollection<ElementId>)	ICollection<ElementId>	Obtains a set of types that are valid for all given elements.	Element
M HasPhases()	bool	Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.	Element
M IsExternalFileReference()	bool	Determines whether this Element represents an external file.	Element
M IsHidden(View)	bool	Identifies if the element has been permanently hidden in the view.	Element
M IsMonitoringLinkElement()	bool	Indicate whether an element is monitoring any elements in any linked models.	Element
M IsMonitoringLocalElement()	bool	Indicate whether an element is monitoring other local elements.	Element
M IsPhaseCreatedValid(ElementId)	bool	Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.	Element
M IsPhaseDemolishedValid(ElementId)	bool	Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.	Element
M IsValidType(Document, ICollection<ElementId>, ElementId)	bool	Checks if given type is valid for the set of elements.	Element
M IsValidType(ElementId)	bool	Checks if given type is valid for this element.	Element
M LookupParameter(String)	nullNothingnullptr	Attempts to find a parameter on the element which has the given name.	Element
M RefersToExternalResourceReference(ExternalResourceType)	bool	Determines whether this Element uses external resources associated with a specified external resource type.	Element
M RefersToExternalResourceReferences()	bool	Determines whether this Element uses external resources.	Element
M SetEntity(Entity)	None	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.	Element
M AddFilter(ElementId)	None	Adds a filter to the view.	View
M AllowsAnalysisDisplay()	bool	Identifies if this view allows display of Analysis results.	View
M ApplyViewTemplateParameters(View)	None	Applies to this view the parameters of the input view that are not controlled by the current view template.	View
M AreGraphicsOverridesAllowed()	bool	Determines if Visibility/Graphics Overriddes can be applied to the view.	View
M CanCategoryBeHidden(ElementId)	bool	Checks whether the category can be hidden in the view.	View
M CanCategoryBeHiddenTemporary(ElementId)	bool	Check if category can be temporarily hidden in the view.	View
M CanEnableTemporaryViewPropertiesMode()	bool	Indicates if Temporary View Properties mode can be applied for view in current state.	View
M CanModifyDetailLevel()	bool	Check if Detail Level can be modified.	View
M CanModifyDisplayStyle()	bool	Indicates if DisplayStyle can be modified.	View
M CanModifyViewDiscipline()	bool	Indicates if the View Discipline can be modified	View
M CanUseDepthCueing()	bool	Indicates if view can use Depth Cueing	View
M CanUseTemporaryVisibilityModes()	bool	Indicates if view can use temporary visibility modes	View
M CanViewBeDuplicated(ViewDuplicateOption)	bool	Identifies if this view can be duplicated.	View
M ConvertTemporaryHideIsolateToPermanent()	None	Convert all temporary hidden elements or categories to permanently hidden in view.	View
M ConvertToIndependent()	None	Convert the dependent view to independent.	View
M CreateViewTemplate()	View	Creates a new view template instance from this view instance.	View
M DisableTemporaryViewMode(TemporaryViewMode)	None	Disables the specified temporary view mode.	View
M Duplicate(ViewDuplicateOption)	ElementId	Duplicates this view.	View
M EnableRevealHiddenMode()	None	Enables Reveal Hidden elements mode.	View
M EnableTemporaryViewPropertiesMode(ElementId)	bool	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.	View
M GetBackground()	Current background.	Returns the current background set for the view.	View
M GetCategoryHidden(ElementId)	bool	Checks if elements of the given category are set to be invisible (hidden) in this view.	View
M GetCategoryOverrides(ElementId)	OverrideGraphicSettings	Gets graphic overrides for a category in view.	View
M GetCropRegionShapeManagerForReferenceCallout(Document, ElementId)	ViewCropRegionShapeManager	Returns an object for managing view crop region shape for reference callout.	View
M GetCropRegionShapeManager()	ViewCropRegionShapeManager	Returns an object for managing view crop region shape.	View
M GetDependentViewIds()	ICollection<ElementId>	Get the ids of dependent views.	View
M GetDepthCueing()	ViewDisplayDepthCueing	Returns the current depth cueing settings for the view.	View
M GetDirectContext3DHandleOverrides()	DirectContext3DHandleOverrides	Returns DirectContext3D handle overrides object for the view.	View
M GetElementOverrides(ElementId)	OverrideGraphicSettings	Gets graphic overrides for an element in the view.	View
M GetFilterOverrides(ElementId)	OverrideGraphicSettings	Gets graphic overrides that a filter applies to the view.	View
M GetFilters()	ICollection<ElementId>	Gets the filters applied to the view.	View
M GetFilterVisibility(ElementId)	bool	Gets the visibility of the elements associated with a filter.	View
M GetNonControlledTemplateParameterIds()	ICollection<ElementId>	Returns a list of parameters that are not marked as included when this view is used as a template.	View
M GetPointCloudOverrides()	PointCloudOverrides	Returns point cloud overrides object for the view.	View
M GetPrimaryViewId()	ElementId	Get the id of the primary view.	View
M GetReferenceCallouts()	ICollection<ElementId>	Returns element ids of all reference callouts in the view.	View
M GetReferenceElevations()	ICollection<ElementId>	Returns element ids of all reference elevations in the view.	View
M GetReferenceSections()	ICollection<ElementId>	Returns element ids of all reference sections in the view.	View
M GetSketchyLines()	ViewDisplaySketchyLines	Returns the current sketchy lines settings for the view.	View
M GetTemplateParameterIds()	IList<ElementId>	Returns a list of parameter ids that may be controlled when this view is assigned as a template.	View
M GetTemporaryViewPropertiesId()	ElementId	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.	View
M GetTemporaryViewPropertiesName()	string	When Temporary View Properties mode is in progress, name of applied template is returned. Outside Temporary View Properties mode, empty string will be returned.	View
M GetViewDisplayModel()	ViewDisplayModel	Returns the current view display model settings for the view.	View
M GetWorksetVisibility(WorksetId)	WorksetVisibility	Returns the visibility settings of a workset for this particular view.	View
M GetWorksharingDisplayMode()	WorksharingDisplayMode	Gets the current worksharing display mode for this view.	View
M HasDetailLevel()	bool	Check if the view has a Detail Level property	View
M HasDisplayStyle()	bool	Indicates if view has a DisplayStyle property	View
M HasViewDiscipline()	bool	Indicates if the view has a Discipline property	View
M HideActiveWorkPlane()	None	Hide the active work plane of the view.	View
M HideCategoriesTemporary(ICollection<ElementId>)	None	Set multiple categories to be temporarily hidden in the view.	View
M HideCategoryTemporary(ElementId)	None	Set one category to be temporarily hidden in the view.	View
M HideElements(ICollection<ElementId>)	None	Sets the elements to be hidden in the view.	View
M HideElementsTemporary(ICollection<ElementId>)	None	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.	View
M HideElementTemporary(ElementId)	None	Set one element to be temporarily hidden in the view.	View
M IsCategoryOverridable(ElementId)	bool	Checks whether the category can have graphic overrides in this view.	View
M IsElementVisibleInTemporaryViewMode(TemporaryViewMode, ElementId)	bool	Identifies if the input element is visible for the temporary view mode for this view.	View
M IsFilterApplied(ElementId)	bool	Indicates if a filter is applied to the view.	View
M IsInTemporaryViewMode(TemporaryViewMode)	bool	Returns true if the view is in a particular temporary view mode.	View
M IsolateCategoriesTemporary(ICollection<ElementId>)	None	Set categories to be temporarily isolated in the view.	View
M IsolateCategoryTemporary(ElementId)	None	Set one category to be temporarily isolated in the view.	View
M IsolateElementsTemporary(ICollection<ElementId>)	None	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.	View
M IsolateElementTemporary(ElementId)	None	Set one element to be temporarily isolated in the view.	View
M IsTemporaryHideIsolateActive()	bool	Indicates if the view is temporarily hiding or isolating elements or categories.	View
M IsTemporaryViewPropertiesModeEnabled()	bool	Returns true when Temporary View Properties mode is in progress, false otherwise.	View
M IsValidViewScale(Int32)	bool	This validator checks that the view scale is in the allowable range.	View
M IsValidViewTemplate(ElementId)	bool	Verifies that the view represented by templateId can be set as the controlling view template for this view.	View
M IsViewValidForTemplateCreation()	bool	Verifies that the view is valid for template creation.	View
M IsWorksetVisible(WorksetId)	bool	Indicates whether the workset is visible in this view.	View
M Print()	None	Print this view with the default view template and using the print setting of the current active document.	View
M Print(Boolean)	None	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.	View
M Print(View)	None	Print this view with the given view template and using the print setting of the current active document.	View
M Print(View, Boolean)	None	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.	View
M RemoveFilter(ElementId)	None	Removes a filter from the view.	View
M SetBackground(ViewDisplayBackground)	None	Sets the background for the view. Background can only be set for 3d views and for Sections/Elevations.	View
M SetCategoryHidden(ElementId, Boolean)	None	Sets if elements of the given category will be visible in this view.	View
M SetCategoryOverrides(ElementId, OverrideGraphicSettings)	None	Sets graphic overrides for a category in view.	View
M SetDepthCueing(ViewDisplayDepthCueing)	None	Sets the depth cueing settings for the view.	View
M SetElementOverrides(ElementId, OverrideGraphicSettings)	None	Sets graphic overrides for an element in the view.	View
M SetFilterOverrides(ElementId, OverrideGraphicSettings)	None	Sets the overrides associated with a filter.	View
M SetFilterVisibility(ElementId, Boolean)	None	Sets the visibility of the elements associated with a filter.	View
M SetNonControlledTemplateParameterIds(ICollection<ElementId>)	None	Sets the parameters that will not be included when this view is used as a template.	View
M SetSketchyLines(ViewDisplaySketchyLines)	None	Sets the sketchy lines settings for the view.	View
M SetViewDisplayModel(ViewDisplayModel)	None	Sets the view display model settings for the view.	View
M SetWorksetVisibility(WorksetId, WorksetVisibility)	None	Sets visibility for a workset in this view.	View
M SetWorksharingDisplayMode(WorksharingDisplayMode)	None	Sets the worksharing display mode for this view.	View
M ShowActiveWorkPlane()	None	Show the active work plane of the view.	View
M SupportsRevealConstraints()	bool	Checks that the view can have the Reveal Constraints mode activated.	View
M SupportsWorksharingDisplayMode(WorksharingDisplayMode)	bool	Checks whether this view supports the given worksharing display mode.	View
M UnhideElements(ICollection<ElementId>)	None	Sets the elements to be shown in the given view if they are currently hidden.	View

Name	Return Type	Description	Inherited From
P AreaScheme	AreaScheme	The area scheme.
P AssemblyInstanceId	ElementId	The id of the assembly instance to which the element belongs.	Element
P BoundingBox	BoundingBoxXYZ	Retrieves a box that circumscribes all geometry of the element.	Element
P Category	Category	Retrieves a Category object that represents the category or sub category in which the element resides.	Element
P CreatedPhaseId	ElementId	Id of a Phase at which the Element was created.	Element
P DemolishedPhaseId	ElementId	Id of a Phase at which the Element was demolished.	Element
P DesignOption	DesignOption	Returns the design option to which the element belongs.	Element
P Document	Document	Returns the Document in which the Element resides.	Element
P Geometry	GeometryElement	Retrieves the geometric representation of the element.	Element
P GroupId	ElementId	The id of the group to which an element belongs.	Element
P Id	ElementId	A unique identifier for an Element in an Autodesk Revit project.	Element
P IsTransient	bool	Indicates whether an element is transient or permanent.	Element
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.	Element
P LevelId	ElementId	The id of the level associated with the element.	Element
P Location	Location	This property is used to find the physical location of an element within a project.	Element
P Name	string	A human readable name for the Element.	Element
P OwnerViewId	ElementId	The id of the view that owns the element.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a parameter id.	Element
P Parameter	Parameter	Retrieves a parameter from the element based on its definition.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a GUID for a shared parameter.	Element
P ParametersMap	ParameterMap	Retrieves a map containing all of the parameters that are contained within the element.	Element
P Parameters	ParameterSet	Retrieves a set containing all of the parameters that are contained within the element.	Element
P Pinned	bool	Identifies if the element has been pinned to prevent changes.	Element
P UniqueId	string	A stable unique identifier for an element within the document.	Element
P ViewSpecific	bool	Identifies if the element is owned by a view.	Element
P WorksetId	WorksetId	Get Id of the Workset which owns the element.	Element
P AnalysisDisplayStyleId	ElementId	Element id of Analysis Display Style associated with the view.	View
P AreAnalyticalModelCategoriesHidden	bool	Indicates if analytical model categories are currently hidden in the view.	View
P AreAnnotationCategoriesHidden	bool	Indicates if annotation categories are currently hidden in the view.	View
P AreCoordinationModelHandlesHidden	bool	Indicates if Coordination Model handles are currently hidden in the view.	View
P AreImportCategoriesHidden	bool	Indicates if import categories are currently hidden in the view.	View
P AreModelCategoriesHidden	bool	Indicates if model categories are currently hidden in the view.	View
P ArePointCloudsHidden	bool	Indicates if point clouds are currently hidden in the view.	View
P AssociatedAssemblyInstanceId	ElementId	The Id of the assembly instance that owns the assembly view.	View
P CanBePrinted	bool	Test whether the view can be printed.	View
P CropBoxActive	bool	Whether or not the Crop Box/Region is active for the view.	View
P CropBox	BoundingBoxXYZ	The Crop Box applied to the view, or an outline encompassing the crop region applied to the view.	View
P CropBoxVisible	bool	Whether or not the Crop Box/Region is visible for the view.	View
P DetailLevel	ViewDetailLevel	The detail level of this view.	View
P Discipline	ViewDiscipline	The Discipline of the view.	View
P DisplayStyle	DisplayStyle	The DisplayStyle of the view. Returns DisplayStyle.Wireframe if the view has no display style.	View
P GenLevel	Level	The level for the view.	View
P IsAssemblyView	bool	Indicates if the view is assembly view.	View
P IsTemplate	bool	Test whether the view is a view template.	View
P Origin	XYZ	Returns the origin of the screen.	View
P Outline	BoundingBoxUV	The bounds of the view in paper space (in feet).	View
P PartsVisibility	PartsVisibility	The visibility setting for parts in this view.	View
P RevealConstraintsMode	bool	Indicates whether the Reveal Constraints mode is activated in the view.	View
P RightDirection	XYZ	The direction towards the right side of the screen.	View
P Scale	int	The scale of the view.	View
P ShadowIntensity	int	The intesity of cast shadows - 0 = no shadows, 100 = black.	View
P SketchPlane	SketchPlane	The sketch plane assigned to the view for model curve creation.	View
P SunAndShadowSettings	SunAndShadowSettings	The sun and shadow settings assigned to the view for shadow calculation and rendering.	View
P SunlightIntensity	int	The intensity of the simulated (directional) sunlight. 0 = no directional light; maximum value is 100.	View
P TemporaryViewModes	TemporaryViewModes	Data of temporary view modes associated with this view.	View
P Title	string	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.	View
P UpDirection	XYZ	The direction towards the top of the screen.	View
P ViewDirection	XYZ	The direction towards the viewer.	View
P ViewTemplateId	ElementId	The id of the template view that controls this view's parameters.	View
P ViewType	ViewType	The type of the view.	View