AreaFilter Class

A filter used to match areas.

Inheritance Hierarchy

System.Object
  Autodesk.Revit.DB.ElementFilter
    Autodesk.Revit.DB.ElementSlowFilter
      Autodesk.Revit.DB.AreaFilter

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

Syntax

C#

public class AreaFilter : ElementSlowFilter

The AreaFilter type exposes the following members.

Constructors

	Name	Description
	AreaFilter	Constructs a filter which matches only areas.

Properties

	Name	Description
	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)
	IsValidObject	Specifies whether the .NET object represents a valid Revit entity. (Inherited from ElementFilter)

Methods

	Name	Description
	Dispose	(Inherited from ElementFilter)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	PassesFilter(Element)	Applies the filter to a given element. (Inherited from ElementFilter)
	PassesFilter(Document, ElementId)	Applies the filter to a given element. (Inherited from ElementFilter)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Remarks

This filter is a slow filter, but it uses a quick filter to eliminate non-candidate elements before the elements are obtained and expanded. Therefore this filter does not have to be paired with another quick filter to minimize the number of Elements that are expanded.

Example

C#

// Use a AreaFilter to find all area elements in the document. It is necessary to use the AreaFilter, 
// and not an ElementClassFilter or the shortcut method OfClass() because the area class is not 
// supported by those methods.
AreaFilter filter = new AreaFilter();

// Apply the filter to the elements in the active document
FilteredElementCollector collector = new FilteredElementCollector(document);
IList<Element> areas = collector.WherePasses(filter).ToElements();

VB

' Use a AreaFilter to find all area elements in the document. It is necessary to use the AreaFilter, 
' and not an ElementClassFilter or the shortcut method OfClass() because the area class is not 
' supported by those methods.
Dim filter As New AreaFilter()

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