Share

FilterElementIdRule Class

A filter rule that operates on ElementId values in a Revit project.

Inheritance Hierarchy

System.Object
  Autodesk.Revit.DB.FilterRule
    Autodesk.Revit.DB.FilterValueRule
      Autodesk.Revit.DB.FilterNumericValueRule
        Autodesk.Revit.DB.FilterElementIdRule


Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)

Syntax

C#

public class FilterElementIdRule : FilterNumericValueRule

The FilterElementIdRule type exposes the following members.

Constructors

 NameDescription
Public methodFilterElementIdRule Constructs an instance of FilterElementIdRule.

Properties

 NameDescription
Public propertyIsValidObject Specifies whether the .NET object represents a valid Revit entity.
(Inherited from FilterRule)
Public propertyRuleValue The user-supplied value against which values from a Revit document will be tested.

Methods

 NameDescription
Public methodDispose
(Inherited from FilterRule)
Public methodElementPasses Derived classes override this method to implement the test that determines whether the given element passes this rule or not.
(Inherited from FilterRule)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetEvaluator Gets the evaluator that implements the test for this rule.
(Inherited from FilterNumericValueRule)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetRuleParameter Returns the ElementId of the parameter associated to this FilterRule if there is one, or invalidElementId if there is no associated parameter.
(Inherited from FilterRule)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodSetEvaluator Sets the evaluator that implements the test for this rule.
(Inherited from FilterNumericValueRule)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodStatic memberUsesLevelFiltering This function checks if a parameter uses level filtering.

Remarks

When GetRuleParameter() returns a parameter that UsesLevelFiltering(Document, ElementId), then the comparisons will first compare the values of the levels' elevations, then compare the levels' names, and finally the levels' element ids to rank and sort the levels.

See Also

Reference

Was this information helpful?