StructuralInstanceUsageFilter
A filter used to find elements that are structural family instances (typically columns, beams or braces) of the given structural usage.
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.ElementFilter
Autodesk.Revit.DB.ElementSlowFilter
Autodesk.Revit.DB.Structure.StructuralInstanceUsageFilter
Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class StructuralInstanceUsageFilter : ElementSlowFilterThe StructuralInstanceUsageFilter type exposes the following members.
Constructors
Name
Description
Public Method
StructuralInstanceUsageFilter(StructuralInstanceUsage)
Constructs a new instance of a filter to match structural family instances (typically columns, beams, or braces) of the given structural usage.
Public Method
StructuralInstanceUsageFilter(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.
Properties
Name
Description
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)
Public Property
StructuralUsage
The family instance structural usage.
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 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.