Namespace: Autodesk.Revit.DB

FamilyInstanceFilter

Class

Description:
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.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ElementFilter
    Autodesk.Revit.DB.ElementSlowFilter
      Autodesk.Revit.DB.FamilyInstanceFilter

Syntax

public class FamilyInstanceFilter : ElementSlowFilter

Public Class FamilyInstanceFilter
	Inherits ElementSlowFilter

public ref class FamilyInstanceFilter : public ElementSlowFilter

type FamilyInstanceFilter = 
    class
        inherit ElementSlowFilter
    end

Examples

// 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();

' 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"
Dim collector As New FilteredElementCollector(document)
collector = collector.OfClass(GetType(FamilySymbol))

' Get Element Id for family symbol which will be used to find family instances
Dim query As System.Collections.Generic.IEnumerable(Of Autodesk.Revit.DB.Element)
query = From element In collector _
 Where element.Name = "Level 1" _
 Select element

Dim famSyms As List(Of Element) = query.ToList()
Dim symbolId As ElementId = famSyms(0).Id

' Create a FamilyInstance filter with the FamilySymbol Id
Dim filter As New FamilyInstanceFilter(document, symbolId)

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

FamilyInstanceFilter Class Members:

Name	Description	Inherited From
FamilyInstanceFilter	Constructs a new instance of a filter to match family instances of the given family symbol.

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

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