Element
|
A filter used to match elements by their category.
Inheritance Hierarchy
System
Object
Autodesk.Revit.DB ElementFilter
Autodesk.Revit.DB ElementQuickFilter
Autodesk.Revit.DB ElementCategoryFilter
Autodesk.Revit.DB ElementFilter
Autodesk.Revit.DB ElementQuickFilter
Autodesk.Revit.DB ElementCategoryFilter
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 27.0.4.0 (27.0.4.0)
Syntax
The ElementCategoryFilter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
ElementCategoryFilter(BuiltInCategory) | Constructs a new instance of a filter to match elements by category. |
|
|
ElementCategoryFilter(ElementId) | Constructs a new instance of a filter to match elements by category. |
|
|
ElementCategoryFilter(BuiltInCategory, Boolean) | 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. |
|
|
ElementCategoryFilter(ElementId, Boolean) | 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. |
Properties
| Name | Description | |
|---|---|---|
|
CategoryId | The category id. |
|
|
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 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.
Example
C#
// 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);