FamilyStructuralMaterialTypeFilter
Description:
A filter used to match families that have the given structural material type.
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.
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
System.Object
Autodesk.Revit.DB.ElementFilter
Autodesk.Revit.DB.ElementSlowFilter
Autodesk.Revit.DB.Structure.FamilyStructuralMaterialTypeFilter
public class FamilyStructuralMaterialTypeFilter : ElementSlowFilter
// 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 |
|---|---|---|---|
| FamilyStructuralMaterialTypeFilter(StructuralMaterialType) | None | Constructs a new instance of a filter to match families that have the given structural material type. | |
| 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 |
|---|---|---|---|
| Dispose() | None | Releases all resources used by the | ElementFilter |
| PassesFilter(Document, ElementId) | bool | Applies the filter to a given element. | ElementFilter |
| PassesFilter(Element) | bool | Applies the filter to a given element. | ElementFilter |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| StructuralMaterialType | StructuralMaterialType | The family structural material type. | |
| 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. | ElementFilter |
| IsValidObject | bool | Specifies whether the .NET object represents a valid Revit entity. | ElementFilter |