RoomFilter Class

A filter used to match rooms.

Inheritance Hierarchy

SystemObject
  Autodesk.Revit.DBElementFilter
    Autodesk.Revit.DBElementSlowFilter
      Autodesk.Revit.DB.ArchitectureRoomFilter

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

Syntax

C++

Copy

public class RoomFilter : ElementSlowFilter

Public Class RoomFilter
	Inherits ElementSlowFilter

public ref class RoomFilter : public ElementSlowFilter

type RoomFilter = 
    class
        inherit ElementSlowFilter
    end

The RoomFilter type exposes the following members.

Constructors

	Name	Description
	RoomFilter	Constructs a filter which matches only rooms.

Top

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)

Top

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)

Top

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++

Copy

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

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

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

' 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()

Reference

Autodesk.Revit.DB.Architecture Namespace