2027 Class
Changes 0
C

ElementCategoryFilter

Description:
A filter used to match elements by their category.
Remarks:
This filter is a quick filter. Quick filters operate only on the ElementRecord, a low-memory class which has a limited interface to read element properties. Elements which are rejected by a quick filter will not be expanded in memory.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ElementFilter
    Autodesk.Revit.DB.ElementQuickFilter
      Autodesk.Revit.DB.ElementCategoryFilter
// Find all Wall instances in the document by using category filter
ElementCategoryFilter filter = new ElementCategoryFilter(BuiltInCategory.OST_Walls);

// Apply the filter to the elements in the active document,
// Use shortcut WhereElementIsNotElementType() to find wall instances only
FilteredElementCollector collector = new FilteredElementCollector(document);
IList<Element> walls = collector.WherePasses(filter).WhereElementIsNotElementType().ToElements();
String prompt = "The walls in the current document are:\n";
foreach (Element e in walls)
{
    prompt += e.Name + "\n";
}
TaskDialog.Show("Revit", prompt);
Name Return Type Description Inherited From
C ElementCategoryFilter(BuiltInCategory) None Constructs a new instance of a filter to match elements by category.
C ElementCategoryFilter(ElementId) None Constructs a new instance of a filter to match elements by category.
C ElementCategoryFilter(BuiltInCategory, Boolean) None Constructs a new instance of a filter to match elements by category, with the option to match all elements which are not of the given category.
C ElementCategoryFilter(ElementId, Boolean) None Constructs a new instance of a filter to match elements by category, with the option to match all elements which are of the given category.
Name Return Type Description Inherited From
M Dispose() None (Inherited from ElementFilter ) ElementFilter
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M PassesFilter(Element) Boolean Applies the filter to a given element. (Inherited from ElementFilter ) ElementFilter
M PassesFilter(Document, ElementId) Boolean Applies the filter to a given element. (Inherited from ElementFilter ) ElementFilter
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P CategoryId ElementId The category id.
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. (Inherited from ElementFilter ) ElementFilter
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity. (Inherited from ElementFilter ) ElementFilter