2021 Members
Changes 1
M

ViewSystemsAnalysisReport Methods

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