FamilyInstanceFilter
Description:
A filter used to find elements that are family instances of the given family symbol.
A filter used to find elements that are family instances of the given family symbol.
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.
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.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.ElementFilter
Autodesk.Revit.DB.ElementSlowFilter
Autodesk.Revit.DB.FamilyInstanceFilter
System.Object
Autodesk.Revit.DB.ElementFilter
Autodesk.Revit.DB.ElementSlowFilter
Autodesk.Revit.DB.FamilyInstanceFilter
public class FamilyInstanceFilter : ElementSlowFilter
// Creates a FamilyInstance filter for elements that are family instances of the given family symbol in the document
// Find all family symbols whose name is "W10X49"
FilteredElementCollector collector = new FilteredElementCollector(document);
collector = collector.OfClass(typeof(FamilySymbol));
// Get Element Id for family symbol which will be used to find family instances
var query = from element in collector where element.Name == "W10X49" select element;
List<Element> famSyms = query.ToList<Element>();
ElementId symbolId = famSyms[0].Id;
// Create a FamilyInstance filter with the FamilySymbol Id
FamilyInstanceFilter filter = new FamilyInstanceFilter(document, symbolId);
// Apply the filter to the elements in the active document
collector = new FilteredElementCollector(document);
ICollection<Element> familyInstances = collector.WherePasses(filter).ToElements();
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| FamilyInstanceFilter(Document, ElementId) | None | Constructs a new instance of a filter to match family instances of the given family symbol. |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| Dispose() | None | (Inherited from ElementFilter ) | ElementFilter |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| PassesFilter(Element) | Boolean | Applies the filter to a given element. (Inherited from ElementFilter ) | ElementFilter |
| PassesFilter(Document, ElementId) | Boolean | Applies the filter to a given element. (Inherited from ElementFilter ) | ElementFilter |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| FamilySymbolId | ElementId | The family symbol id. | |
| 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 |
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. (Inherited from ElementFilter ) | ElementFilter |