ElementParameterFilter

Description:
A filter used to match elements by one or more parameter filter rules.

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.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ElementFilter
    Autodesk.Revit.DB.ElementSlowFilter
      Autodesk.Revit.DB.ElementParameterFilter

public class ElementParameterFilter : ElementSlowFilter

Public Class ElementParameterFilter _
	Inherits ElementSlowFilter

public ref class ElementParameterFilter : public ElementSlowFilter

// Creates an ElementParameter filter to find rooms whose area is 
// greater than specified value
// Create filter by provider and evaluator 
// provider
ParameterValueProvider pvp = new ParameterValueProvider(new ElementId(BuiltInParameter.ROOM_AREA));
// evaluator
FilterNumericRuleEvaluator fnrv = new FilterNumericGreater();
// rule value    
double ruleValue = 100.0f; // filter room whose area is greater than 100 SF
// rule
FilterRule fRule = new FilterDoubleRule(pvp, fnrv, ruleValue, 1E-6);

// Create an ElementParameter filter
ElementParameterFilter filter = new ElementParameterFilter(fRule);

// Apply the filter to the elements in the active document
FilteredElementCollector 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 elements
ElementParameterFilter lessOrEqualFilter = new ElementParameterFilter(fRule, true); 
collector = new FilteredElementCollector(document);
IList<Element> lessOrEqualFounds = collector.WherePasses(lessOrEqualFilter).ToElements();

' Creates an ElementParameter filter to find rooms whose area is 
' greater than specified value
' Create filter by provider and evaluator 
' provider
Dim pvp As New ParameterValueProvider(New ElementId(BuiltInParameter.ROOM_AREA))
' evaluator
Dim fnrv As FilterNumericRuleEvaluator = New FilterNumericGreater()
' rule value    
Dim ruleValue As Double = 100.0F
' filter room whose area is greater than 100 SF
' rule
Dim fRule As FilterRule = New FilterDoubleRule(pvp, fnrv, ruleValue, 0.000001)

' Create an ElementParameter filter
Dim filter As New ElementParameterFilter(fRule)

' Apply the filter to the elements in the active document
Dim collector As New FilteredElementCollector(document)
Dim rooms As IList(Of Element) = collector.WherePasses(filter).ToElements()


' Find rooms whose area is less than or equal to 100: 
' Use inverted filter to match elements
Dim lessOrEqualFilter As New ElementParameterFilter(fRule, True)
collector = New FilteredElementCollector(document)
Dim lessOrEqualFounds As IList(Of Element) = collector.WherePasses(lessOrEqualFilter).ToElements()

Name	Return Type	Description
C ElementParameterFilter(FilterRule)	None	Constructs a new instance of an ElementParameterFilter from a single rule.
C ElementParameterFilter(FilterRule, Boolean)	None	Constructs a new instance of an ElementParameterFilter, with the option to match all elements not passing a given filter rule.
C ElementParameterFilter(IList<FilterRule>)	None	Constructs a new instance of an ElementParameterFilter from a set of rules.
C ElementParameterFilter(IList<FilterRule>, Boolean)	None	Constructs a new instance of an ElementParameterFilter, with the option to match all elements not passing the given filter rules.

Name	Return Type	Description	Inherited From
M GetRules()	IList<FilterRule>	Returns the set of rules contained in this filter.
M Dispose()	None	Releases all resources used by the	ElementFilter
M PassesFilter(Document, ElementId)	bool	Applies the filter to a given element.	ElementFilter
M PassesFilter(Element)	bool	Applies the filter to a given element.	ElementFilter

Name	Return Type	Description	Inherited From
P Inverted	bool	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.	ElementFilter
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.	ElementFilter