FamilySymbolFilter

Public Class

A filter used to find all family symbols of the given family.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ElementFilter
Autodesk.Revit.DB.ElementQuickFilter
Autodesk.Revit.DB.FamilySymbolFilter

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class FamilySymbolFilter : ElementQuickFilter

The FamilySymbolFilter type exposes the following members.

Constructors

Name

Description

Public Method
FamilySymbolFilter

Constructs a new instance of a filter to find all family symbols of the given family.

Properties

Name

Description

Public Property

FamilyId

The family id.

Public Property

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)

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from ElementFilter)

Methods

Name

Description

Public Method

Dispose

(Inherited from ElementFilter)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

PassesFilter(Element)

Applies the filter to a given element.
(Inherited from ElementFilter)

Public Method

PassesFilter(Document, ElementId)

Applies the filter to a given element.
(Inherited from ElementFilter)

Public Method

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.

Note that it may be faster to get a list of symbol ids from

GetFamilySymbolIds.

rather than to iterate all of the contents of a document with this filter applied.