FilterDialog

Public Class

Allows display of the dialog used to create and edit FilterElements in Autodesk Revit.

Inheritance Hierarchy

System.Object
Autodesk.Revit.UI.FilterDialog

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

Syntax

public class FilterDialog : IDisposable

The FilterDialog type exposes the following members.

Constructors

Name

Description

Public Method
FilterDialog(Document, ElementId)

Constructs a new instance of the FilterDialog class, while setting the id of the FilterElement to be selected when the dialog is shown.

Public Method
FilterDialog(Document, String)

Constructs a new instance of the FilterDialog class, while setting the name of the new ParameterFilterElement to be created and selected for editing.

Properties

Name

Description

Public Property

FilterToSelect

The filter element to be selected once Show is invoked.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Public Property

NewFilterId

The ElementId of the new filter created. The value is populated after Show method is executed.

Public Property

NewFilterName

The name of the new ParameterFilterElement to be created and selected once Show is invoked.

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the FilterDialog

Public Method

Equals

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

Public Method

GetHashCode

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

Public Method

GetType

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

Public Method
Show

Shows the FilterDialog editing dialog to the user.

Public Method

ToString

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

Remarks

The class provides the option to launch the dialog by selecting an existing FilterElement, or automatically creating a new ParameterFilterElement. In both cases the affected element will be selected for editing. Note that the user may opt to add, delete or edit any of the available filter elements (or make no changes at all).