ElementParameterFilter
A filter used to match elements by one or more parameter filter rules.
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.ElementFilter
Autodesk.Revit.DB.ElementSlowFilter
Autodesk.Revit.DB.ElementParameterFilter
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class ElementParameterFilter : ElementSlowFilterThe ElementParameterFilter type exposes the following members.
Constructors
Name
Description
Public Method
ElementParameterFilter(FilterRule)
Constructs a new instance of an ElementParameterFilter from a single rule.
Public Method
ElementParameterFilter(IList.FilterRule.)
Constructs a new instance of an ElementParameterFilter from a set of rules.
Public Method
ElementParameterFilter(FilterRule, Boolean)
Constructs a new instance of an ElementParameterFilter, with the option to match all elements not passing a given filter rule.
Public Method
ElementParameterFilter(IList.FilterRule., Boolean)
Constructs a new instance of an ElementParameterFilter, with the option to match all elements not passing the given filter rules.
Properties
Name
Description
Public Property
Inverted
True if the results of the filter are inverted; elements that would normally be accepted by this filter will be rejected, and elements that would normally be rejected will be accepted.
(Inherited from ElementFilter)
Public Property
IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from ElementFilter)
Methods
Name
Description
Public Method
Dispose
(Inherited from ElementFilter)
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
GetRules
Returns the set of rules contained in this filter.
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object)
Public Method
PassesFilter(Element)
Applies the filter to a given element.
(Inherited from ElementFilter)
Public Method
PassesFilter(Document, ElementId)
Applies the filter to a given element.
(Inherited from ElementFilter)
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object)
Remarks
This filter is a slow filter. Slow filters require that the Element be obtained and expanded in memory first. Thus it is preferable to couple this filter with at least one ElementQuickFilter, which should minimize the number of Elements that are expanded.
Example
// Creates an ElementParameter filter to find rooms whose area is// greater than specified value// Create filter by provider and evaluator// providerParameterValueProvider pvp = new ParameterValueProvider(new ElementId(BuiltInParameter.ROOM_AREA));// evaluatorFilterNumericRuleEvaluator fnrv = new FilterNumericGreater();// rule valuedouble ruleValue = 100.0f; // filter room whose area is greater than 100 SF// ruleFilterRule fRule = new FilterDoubleRule(pvp, fnrv, ruleValue, 1E-6);
// Create an ElementParameter filterElementParameterFilter filter = new ElementParameterFilter(fRule);
// Apply the filter to the elements in the active documentFilteredElementCollector collector = new FilteredElementCollector(document);IList<Element> rooms = collector.WherePasses(filter).ToElements();
// Find rooms whose area is less than or equal to 100:// Use inverted filter to match elementsElementParameterFilter lessOrEqualFilter = new ElementParameterFilter(fRule, true);collector = new FilteredElementCollector(document);IList<Element> lessOrEqualFounds = collector.WherePasses(lessOrEqualFilter).ToElements();