2027 Class
Changes 0
C

FamilyStructuralMaterialTypeFilter

Description:
A filter used to match families that have the given structural material type.
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.Structure.FamilyStructuralMaterialTypeFilter
// Use FamilyStructuralMaterialType filter to find families whose material type is Wood
FamilyStructuralMaterialTypeFilter filter = new FamilyStructuralMaterialTypeFilter(StructuralMaterialType.Wood);

// Apply the filter to the elements in the active document
FilteredElementCollector collector = new FilteredElementCollector(document);
ICollection<Element> woodFamiles = collector.WherePasses(filter).ToElements();

// Find families are not Wood: Use inverted filter to match families
FamilyStructuralMaterialTypeFilter notWoodFilter =
    new FamilyStructuralMaterialTypeFilter(StructuralMaterialType.Wood, true); // inverted filter
collector = new FilteredElementCollector(document);
ICollection<Element> notWoodFamilies = collector.WherePasses(notWoodFilter).ToElements();
Name Return Type Description Inherited From
C FamilyStructuralMaterialTypeFilter(StructuralMaterialType) None Constructs a new instance of a filter to match families that have the given structural material type.
C FamilyStructuralMaterialTypeFilter(StructuralMaterialType, Boolean) None Constructs a new instance of a filter to match families by structural material type, with the option to match all families which are not of the given structural material type.
Name Return Type Description Inherited From
M Dispose() None (Inherited from ElementFilter ) ElementFilter
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M PassesFilter(Element) Boolean Applies the filter to a given element. (Inherited from ElementFilter ) ElementFilter
M PassesFilter(Document, ElementId) Boolean Applies the filter to a given element. (Inherited from ElementFilter ) ElementFilter
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P 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
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity. (Inherited from ElementFilter ) ElementFilter
P StructuralMaterialType StructuralMaterialType The family structural material type.