•  

View Methods

View Methods

The View type exposes the following members.

Methods
Name Description
Public method AddFilter Adds a filter to the view.
Public method AllowsAnalysisDisplay Identifies if this view allows display of Analysis results.
Public method ApplyViewTemplateParameters Applies to this view the parameters of the input view that are not controlled by the current view template.
Public method AreGraphicsOverridesAllowed Determines if Visibility/Graphics Overriddes can be applied to the 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.
Public method CanBeHidden Indicates if the element can be hidden in the view.
(Inherited from Element )
Public method CanBeLocked Identifies if the element can be locked.
(Inherited from Element )
Public method CanCategoryBeHidden Checks whether the category can be hidden in the view.
Public method CanCategoryBeHiddenTemporary Check if category can be temporarily hidden in the view.
Public method CanDeleteSubelement Checks if given subelement can be removed from the element.
(Inherited from Element )
Public method CanEnableTemporaryViewPropertiesMode Indicates if Temporary View Properties mode can be applied for view in current state.
Public method CanHaveTypeAssigned Identifies if the element can have a type assigned.
(Inherited from Element )
Public method CanModifyDetailLevel Check if Detail Level can be modified.
Public method CanModifyDisplayStyle Indicates if DisplayStyle can be modified.
Public method CanModifyViewDiscipline Indicates if the View Discipline can be modified
Public method CanUseDepthCueing Indicates if view can use Depth Cueing
Public method CanUseTemporaryVisibilityModes Indicates if view can use temporary visibility modes
Public method CanViewBeDuplicated Identifies if this view can be duplicated.
Public method ChangeTypeId(ElementId) Changes the type of the element.
(Inherited from Element )
Public method ConvertTemporaryHideIsolateToPermanent Convert all temporary hidden elements or categories to permanently hidden in view.
Public method ConvertToIndependent Convert the dependent view to independent.
Public method CreateViewTemplate Creates a new view template instance from this view instance.
Public method DeleteEntity 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
(Inherited from Element )
Public method DisableTemporaryViewMode Disables the specified temporary view mode.
Public method Dispose
(Inherited from Element )
Public method Duplicate Duplicates this view.
Public method EnableRevealHiddenMode Enables Reveal Hidden elements mode.
Public method EnableTemporaryViewPropertiesMode 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 method Equals Determines whether the specified object is equal to the current object.
(Inherited from Object )
Public method EvaluateAllParameterValues Evaluates all the parameters' values of the element.
(Inherited from Element )
Public method EvaluateParameterValues
(Inherited from Element )
Public method GetBackground Returns the current background set for the view.
Public method GetCalloutParentId Gets ID of the callout parent view.
Public method GetCategoryHidden Checks if elements of the given category are set to be invisible (hidden) in this view.
Public method GetCategoryOverrides Gets graphic overrides for a category in view.
Public method GetColorFillSchemeId Returns id of the color fill scheme element applied to the view.
Public method GetCropRegionShapeManager Returns an object for managing view crop region shape.
Public method Static member GetCropRegionShapeManagerForReferenceCallout Returns an object for managing view crop region shape for reference callout.
Public method GetDependentElements Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element )
Public method GetDependentViewIds Get the ids of dependent views.
Public method GetDepthCueing Returns the current depth cueing settings for the view.
Public method GetDirectContext3DHandleOverrides Returns DirectContext3D handle overrides object for the view.
Public method GetElementOverrides Gets graphic overrides for an element in the 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 GetEntitySchemaGuids Returns the Schema guids of any Entities stored in this element.
(Inherited from Element )
Public method GetExternalFileReference 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 GetFilterOverrides Gets graphic overrides that a filter applies to the view.
Public method GetFilters Gets the filters applied to the view.
Public method GetFilterVisibility Gets the visibility of the elements associated with a filter.
Public method 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.
Public method GetLinkOverrides Gets the graphic overrides of a RevitLinkType or RevitLinkInstance in view.
Public method GetMaterialArea 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 GetMaterialVolume 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.
Public method GetMonitoredLinkElementIds Provides the link instance IDs when the element is monitoring.
(Inherited from Element )
Public method GetMonitoredLocalElementIds 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.
Public method GetOrderedFilters Gets the filters applied to the view in the order they are applied.
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 GetParameterFormatOptions 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 GetPhaseStatus 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.
Public method GetPointCloudOverrides Returns point cloud overrides object for the view.
Public method GetPrimaryViewId Get the id of the primary view.
Public method GetReferenceCallouts Returns element ids of all reference callouts in the view.
Public method GetReferenceElevations Returns element ids of all reference elevations in the view.
Public method GetReferenceSections Returns element ids of all reference sections in the view.
Public method GetSketchyLines Returns the current sketchy lines settings for the view.
Public method GetSubelements Returns the collection of element subelements.
(Inherited from Element )
Public method GetTemplateParameterIds Returns a list of parameter ids that may be controlled when this view is assigned as a template.
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.
Public method GetTemporaryViewPropertiesName 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 method GetType Gets the Type of the current instance.
(Inherited from Object )
Public method GetTypeId Returns the identifier of this element's type.
(Inherited from Element )
Public method GetValidTypes Obtains a set of types that are valid for this element.
(Inherited from Element )
Public method GetViewDisplayModel Returns the current view display model settings for the view.
Public method GetWorksetVisibility Returns the visibility settings of a workset for this particular view.
Public method GetWorksharingDisplayMode Gets the current worksharing display mode for this view.
Public method HasDetailLevel Check if the view has a Detail Level property
Public method HasDisplayStyle Indicates if view has a DisplayStyle property
Public method HasPhases Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element )
Public method HasViewDiscipline Indicates if the view has a Discipline property
Public method HasViewTransforms Returns true if the view reports model space to view projection space transforms.
Public method HideActiveWorkPlane Hide the active work plane of the view.
Public method HideCategoriesTemporary
Public method HideCategoryTemporary Set one category to be temporarily hidden in the view.
Public method HideElements
Public method HideElementsTemporary
Public method HideElementTemporary 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 method IsCategoryOverridable Checks whether the category can have graphic overrides in this view.
Public method IsCreatedPhaseOrderValid Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element )
Public method IsDemolishedPhaseOrderValid Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element )
Public method IsElementVisibleInTemporaryViewMode Identifies if the input element is visible for the temporary view mode for this view.
Public method IsExternalFileReference Determines whether this Element represents an external file.
(Inherited from Element )
Public method IsFilterApplied Indicates if a filter is applied to the view.
Public method IsHidden Identifies if the element has been permanently hidden in the view.
(Inherited from Element )
Public method IsInTemporaryViewMode Returns true if the view is in a particular temporary view mode.
Public method IsMonitoringLinkElement Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element )
Public method IsMonitoringLocalElement Indicate whether an element is monitoring other local elements.
(Inherited from Element )
Public method IsolateCategoriesTemporary
Public method IsolateCategoryTemporary Set one category to be temporarily isolated in the view.
Public method IsolateElementsTemporary
Public method IsolateElementTemporary 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 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 IsTemporaryHideIsolateActive Indicates if the view is temporarily hiding or isolating elements or categories.
Public method IsTemporaryViewPropertiesModeEnabled Returns true when Temporary View Properties mode is in progress, false otherwise.
Public method IsValidType(ElementId) Checks if given type is valid for this element.
(Inherited from Element )
Public method Static member IsValidViewScale This validator checks that the view scale is in the allowable range.
Public method IsValidViewTemplate Verifies that the view represented by templateId can be set as the controlling view template for this view.
Public method IsViewValidForTemplateCreation Verifies that the view is valid for template creation.
Public method IsWorksetVisible Indicates whether the workset is visible in this view.
Public method LookupParameter Attempts to find a parameter on the element which has the given name.
(Inherited from Element )
Public method Print Print this view with the default view template and using the print setting of the current active document.
Public method Print(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 method Print(View) Print this view with the given view template and using the print setting of the current active document.
Public method Print(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 method RefersToExternalResourceReference 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.
Public method RemoveFilter Removes a filter from the view.
Public method RemoveLinkOverrides Deletes the graphical link overrides in the current view.
Public method RestoreCalloutParent Restores callout parent ID to the original view ID if that view is still available.
Public method SetBackground Sets the background for the view. Background can only be set for 3d views and for Sections/Elevations.
Public method SetCategoryHidden Sets if elements of the given category will be visible in this view.
Public method SetCategoryOverrides Sets graphic overrides for a category in view.
Public method SetColorFillSchemeId Applies color fill scheme to this view.
Public method SetDepthCueing Sets the depth cueing settings for the view.
Public method SetElementOverrides Sets graphic overrides for an element in the view.
Public method SetEntity Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element )
Public method SetFilterOverrides Sets the overrides associated with a filter.
Public method SetFilterVisibility Sets the visibility of the elements associated with a filter.
Public method SetIsFilterEnabled Sets the filter enabled flag.
Public method SetLinkOverrides Sets the graphic overrides of a RevitLinkType or RevitLinkInstance in the view.
Public method SetNonControlledTemplateParameterIds
Public method SetSketchyLines Sets the sketchy lines settings for the view.
Public method SetViewDisplayModel Sets the view display model settings for the view.
Public method SetWorksetVisibility Sets visibility for a workset in this view.
Public method SetWorksharingDisplayMode Sets the worksharing display mode for this view.
Public method ShowActiveWorkPlane Show the active work plane of the 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.
Public method SupportsRevealConstraints Checks that the view can have the Reveal Constraints mode activated.
Public method SupportsWorksharingDisplayMode Checks whether this view supports the given worksharing display mode.
Public method ToString Returns a string that represents the current object.
(Inherited from Object )
Public method UnhideElements
Top
See Also