View Methods


The View type exposes the following members.

Methods

  NameDescription
Public methodAddFilter
Adds a filter to the view.
Public methodAllowsAnalysisDisplay
Identifies if this view allows display of Analysis results.
Public methodApplyViewTemplateParameters
Applies to this view the parameters of the input view that are not controlled by the current view template.
Public methodAreGraphicsOverridesAllowed
Determines if Visibility/Graphics Overriddes can be applied to the view.
Public methodArePhasesModifiable
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element.)
Public methodCanApplyColorFillScheme
Checks if the id can be applied as the scheme id of specified category to this view.
Public methodCanBeHidden
Indicates if the element can be hidden in the view.
(Inherited from Element.)
Public methodCanBeLocked
Identifies if the element can be locked.
(Inherited from Element.)
Public methodCanCategoryBeHidden
Checks whether the category can be hidden in the view.
Public methodCanCategoryBeHiddenTemporary
Check if category can be temporarily hidden in the view.
Public methodCanDeleteSubelement
Checks if given subelement can be removed from the element.
(Inherited from Element.)
Public methodCanEnableTemporaryViewPropertiesMode
Indicates if Temporary View Properties mode can be applied for view in current state.
Public methodCanHaveTypeAssigned
Identifies if the element can have a type assigned.
(Inherited from Element.)
Public methodCanModifyDetailLevel
Check if Detail Level can be modified.
Public methodCanModifyDisplayStyle
Indicates if DisplayStyle can be modified.
Public methodCanModifyViewDiscipline
Indicates if the View Discipline can be modified
Public methodCanUseDepthCueing
Indicates if view can use Depth Cueing
Public methodCanUseTemporaryVisibilityModes
Indicates if view can use temporary visibility modes
Public methodCanViewBeDuplicated
Identifies if this view can be duplicated.
Public methodChangeTypeId(ElementId)
Changes the type of the element.
(Inherited from Element.)
Public methodConvertTemporaryHideIsolateToPermanent
Convert all temporary hidden elements or categories to permanently hidden in view.
Public methodConvertToIndependent
Convert the dependent view to independent.
Public methodCreateViewTemplate
Creates a new view template instance from this view instance.
Public methodDeleteEntity
Deletes the existing entity created by %schema% in the element
(Inherited from Element.)
Public methodDeleteSubelement
Removes a subelement from the element.
(Inherited from Element.)
Public methodDeleteSubelements
Removes the subelements from the element.
(Inherited from Element.)
Public methodDisableTemporaryViewMode
Disables the specified temporary view mode.
Public methodDispose (Inherited from Element.)
Public methodDuplicate
Duplicates this view.
Public methodEnableRevealHiddenMode
Enables Reveal Hidden elements mode.
Public methodEnableTemporaryViewPropertiesMode
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.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodEvaluateAllParameterValues
Evaluates all the parameters' values of the element.
(Inherited from Element.)
Public methodEvaluateParameterValues
Evaluate the parameters' values of the element on the given parameter ID set.
(Inherited from Element.)
Public methodGetBackground
Returns the current background set for the view.
Public methodGetCalloutParentId
Gets ID of the callout parent view.
Public methodGetCategoryHidden
Checks if elements of the given category are set to be invisible (hidden) in this view.
Public methodGetCategoryOverrides
Gets graphic overrides for a category in view.
Public methodGetColorFillSchemeId
Returns id of the color fill scheme element applied to the view.
Public methodGetCropRegionShapeManager
Returns an object for managing view crop region shape.
Public methodStatic memberGetCropRegionShapeManagerForReferenceCallout
Returns an object for managing view crop region shape for reference callout.
Public methodGetDependentElements
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element.)
Public methodGetDependentViewIds
Get the ids of dependent views.
Public methodGetDepthCueing
Returns the current depth cueing settings for the view.
Public methodGetDirectContext3DHandleOverrides
Returns DirectContext3D handle overrides object for the view.
Public methodGetElementOverrides
Gets graphic overrides for an element in the view.
Public methodGetEntity
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 methodGetEntitySchemaGuids
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element.)
Public methodGetExternalFileReference
Gets information pertaining to the external file referenced by the element.
(Inherited from Element.)
Public methodGetExternalResourceReference
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.)
Public methodGetExternalResourceReferenceExpanded
Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.)
Public methodGetExternalResourceReferences
Gets the map of the external resource references referenced by the element.
(Inherited from Element.)
Public methodGetExternalResourceReferencesExpanded
Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element.)
Public methodGetFilterOverrides
Gets graphic overrides that a filter applies to the view.
Public methodGetFilters
Gets the filters applied to the view.
Public methodGetFilterVisibility
Gets the visibility of the elements associated with a filter.
Public methodGetGeneratingElementIds
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element.)
Public methodGetGeometryObjectFromReference
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIsFilterEnabled
Identifies if the filter is enabled in this view.
Public methodGetLinkOverrides
Gets the graphic overrides of a RevitLinkType or RevitLinkInstance in view.
Public methodGetMaterialArea
Gets the area of the material with the given id.
(Inherited from Element.)
Public methodGetMaterialIds
Gets the element ids of all materials present in the element.
(Inherited from Element.)
Public methodGetMaterialVolume
Gets the volume of the material with the given id.
(Inherited from Element.)
Public methodGetModelToProjectionTransforms
Gets the transforms from the model space to the view projection space.
Public methodGetMonitoredLinkElementIds
Provides the link instance IDs when the element is monitoring.
(Inherited from Element.)
Public methodGetMonitoredLocalElementIds
Provides the local element IDs when the element is monitoring.
(Inherited from Element.)
Public methodGetNonControlledTemplateParameterIds
Returns a list of parameters that are not marked as included when this view is used as a template.
Public methodGetOrderedFilters
Gets the filters applied to the view in the order they are applied.
Public methodGetOrderedParameters
Gets the parameters associated to the element in order.
(Inherited from Element.)
Public methodGetParameter
Retrieves a parameter from the element given identifier.
(Inherited from Element.)
Public methodGetParameterFormatOptions
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element.)
Public methodGetParameters
Retrieves the parameters from the element via the given name.
(Inherited from Element.)
Public methodGetPhaseStatus
Gets the status of a given element in the input phase
(Inherited from Element.)
Public methodGetPlacementOnSheetStatus
Determines if this view placed on a sheet completely or partially.
Public methodGetPointCloudOverrides
Returns point cloud overrides object for the view.
Public methodGetPrimaryViewId
Get the id of the primary view.
Public methodGetReferenceCallouts
Returns element ids of all reference callouts in the view.
Public methodGetReferenceElevations
Returns element ids of all reference elevations in the view.
Public methodGetReferenceSections
Returns element ids of all reference sections in the view.
Public methodGetSketchyLines
Returns the current sketchy lines settings for the view.
Public methodGetSubelements
Returns the collection of element subelements.
(Inherited from Element.)
Public methodGetTemplateParameterIds
Returns a list of parameter ids that may be controlled when this view is assigned as a template.
Public methodGetTemporaryViewPropertiesId
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.
Public methodGetTemporaryViewPropertiesName
When Temporary View Properties mode is in progress, name of applied template is returned. Outside Temporary View Properties mode, empty string will be returned.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeId
Returns the identifier of this element's type.
(Inherited from Element.)
Public methodGetValidTypes
Obtains a set of types that are valid for this element.
(Inherited from Element.)
Public methodGetViewDisplayModel
Returns the current view display model settings for the view.
Public methodGetWorksetVisibility
Returns the visibility settings of a workset for this particular view.
Public methodGetWorksharingDisplayMode
Gets the current worksharing display mode for this view.
Public methodHasDetailLevel
Check if the view has a Detail Level property
Public methodHasDisplayStyle
Indicates if view has a DisplayStyle property
Public methodHasPhases
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element.)
Public methodHasViewDiscipline
Indicates if the view has a Discipline property
Public methodHasViewTransforms
Returns true if the view reports model space to view projection space transforms.
Public methodHideActiveWorkPlane
Hide the active work plane of the view.
Public methodHideCategoriesTemporary
Set multiple categories to be temporarily hidden in the view.
Public methodHideCategoryTemporary
Set one category to be temporarily hidden in the view.
Public methodHideElements
Sets the elements to be hidden in the view.
Public methodHideElementsTemporary
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.
Public methodHideElementTemporary
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.
Public methodIsCategoryOverridable
Checks whether the category can have graphic overrides in this view.
Public methodIsCreatedPhaseOrderValid
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element.)
Public methodIsDemolishedPhaseOrderValid
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element.)
Public methodIsElementVisibleInTemporaryViewMode
Identifies if the input element is visible for the temporary view mode for this view.
Public methodIsExternalFileReference
Determines whether this Element represents an external file.
(Inherited from Element.)
Public methodIsFilterApplied
Indicates if a filter is applied to the view.
Public methodIsHidden
Identifies if the element has been permanently hidden in the view.
(Inherited from Element.)
Public methodIsInTemporaryViewMode
Returns true if the view is in a particular temporary view mode.
Public methodIsMonitoringLinkElement
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element.)
Public methodIsMonitoringLocalElement
Indicate whether an element is monitoring other local elements.
(Inherited from Element.)
Public methodIsolateCategoriesTemporary
Set categories to be temporarily isolated in the view.
Public methodIsolateCategoryTemporary
Set one category to be temporarily isolated in the view.
Public methodIsolateElementsTemporary
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.
Public methodIsolateElementTemporary
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.
Public methodIsPhaseCreatedValid
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element.)
Public methodIsPhaseDemolishedValid
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element.)
Public methodIsTemporaryHideIsolateActive
Indicates if the view is temporarily hiding or isolating elements or categories.
Public methodIsTemporaryViewPropertiesModeEnabled
Returns true when Temporary View Properties mode is in progress, false otherwise.
Public methodIsValidType(ElementId)
Checks if given type is valid for this element.
(Inherited from Element.)
Public methodStatic memberIsValidViewScale
This validator checks that the view scale is in the allowable range.
Public methodIsValidViewTemplate
Verifies that the view represented by templateId can be set as the controlling view template for this view.
Public methodIsViewValidForTemplateCreation
Verifies that the view is valid for template creation.
Public methodIsWorksetVisible
Indicates whether the workset is visible in this view.
Public methodLookupParameter
Attempts to find a parameter on the element which has the given name.
(Inherited from Element.)
Public methodPrint
Print this view with the default view template and using the print setting of the current active document.
Public methodPrint(Boolean)
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.
Public methodPrint(View)
Print this view with the given view template and using the print setting of the current active document.
Public methodPrint(View, Boolean)
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.
Public methodRefersToExternalResourceReference
Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element.)
Public methodRefersToExternalResourceReferences
Determines whether this Element uses external resources.
(Inherited from Element.)
Public methodRemoveCalloutParent
Replaces callout parent ID with InvalidElementId.
Public methodRemoveFilter
Removes a filter from the view.
Public methodRemoveLinkOverrides
Deletes the graphical link overrides in the current view.
Public methodRestoreCalloutParent
Restores callout parent ID to the original view ID if that view is still available.
Public methodSetBackground
Sets the background for the view. Background can only be set for 3d views and for Sections/Elevations.
Public methodSetCategoryHidden
Sets if elements of the given category will be visible in this view.
Public methodSetCategoryOverrides
Sets graphic overrides for a category in view.
Public methodSetColorFillSchemeId
Applies color fill scheme to this view.
Public methodSetDepthCueing
Sets the depth cueing settings for the view.
Public methodSetElementOverrides
Sets graphic overrides for an element in the view.
Public methodSetEntity
Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element.)
Public methodSetFilterOverrides
Sets the overrides associated with a filter.
Public methodSetFilterVisibility
Sets the visibility of the elements associated with a filter.
Public methodSetIsFilterEnabled
Sets the filter enabled flag.
Public methodSetLinkOverrides
Sets the graphic overrides of a RevitLinkType or RevitLinkInstance in the view.
Public methodSetNonControlledTemplateParameterIds
Sets the parameters that will not be included when this view is used as a template.
Public methodSetSketchyLines
Sets the sketchy lines settings for the view.
Public methodSetViewDisplayModel
Sets the view display model settings for the view.
Public methodSetWorksetVisibility
Sets visibility for a workset in this view.
Public methodSetWorksharingDisplayMode
Sets the worksharing display mode for this view.
Public methodShowActiveWorkPlane
Show the active work plane of the view.
Public methodSupportedColorFillCategoryIds
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.
Public methodSupportsRevealConstraints
Checks that the view can have the Reveal Constraints mode activated.
Public methodSupportsWorksharingDisplayMode
Checks whether this view supports the given worksharing display mode.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnhideElements
Sets the elements to be shown in the given view if they are currently hidden.

See Also