StructuralInstanceUsageFilter Class

StructuralInstanceUsageFilter Class

A filter used to find elements that are structural family instances (typically columns, beams or braces) of the given structural usage.
Inheritance Hierarchy
SystemObject
  Autodesk.Revit.DBElementFilter
    Autodesk.Revit.DBElementSlowFilter
      Autodesk.Revit.DB.StructureStructuralInstanceUsageFilter

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
public class StructuralInstanceUsageFilter : ElementSlowFilter
Public Class StructuralInstanceUsageFilter
	Inherits ElementSlowFilter
public ref class StructuralInstanceUsageFilter : public ElementSlowFilter
type StructuralInstanceUsageFilter = 
    class
        inherit ElementSlowFilter
    end

The StructuralInstanceUsageFilter type exposes the following members.

Constructors
 NameDescription
Public methodStructuralInstanceUsageFilter(StructuralInstanceUsage) Constructs a new instance of a filter to match structural family instances (typically columns, beams, or braces) of the given structural usage.
Public methodStructuralInstanceUsageFilter(StructuralInstanceUsage, Boolean) Constructs a new instance of a filter to match family instances by structural usage, with the option to match all family instances which are not of the given structural usage.
Top
Properties
 NameDescription
Public propertyInverted 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 propertyIsValidObject Specifies whether the .NET object represents a valid Revit entity.
(Inherited from ElementFilter)
Public propertyStructuralUsage The family instance structural usage.
Top
Methods
 NameDescription
Public methodDispose
(Inherited from ElementFilter)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodPassesFilter(Element) Applies the filter to a given element.
(Inherited from ElementFilter)
Public methodPassesFilter(Document, ElementId) Applies the filter to a given element.
(Inherited from ElementFilter)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
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.
See Also

T:Autodesk.Revit.DB.Structure.StructuralInstanceUsageFilter