ElementPhaseStatusFilter
A filter used to match elements that have a given phase status on a given phase.
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.ElementFilter
Autodesk.Revit.DB.ElementSlowFilter
Autodesk.Revit.DB.ElementPhaseStatusFilter
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class ElementPhaseStatusFilter : ElementSlowFilterThe ElementPhaseStatusFilter type exposes the following members.
Constructors
Name
Description
Public Method
ElementPhaseStatusFilter(ElementId, ElementOnPhaseStatus)
Constructs a new instance of a file to match elements that have a given phase status on the input phase.
Public Method
ElementPhaseStatusFilter(ElementId, ICollection.ElementOnPhaseStatus.)
Constructs a new instance of a file to match elements that have a given phase statuses on the input phase.
Public Method
ElementPhaseStatusFilter(ElementId, ElementOnPhaseStatus, Boolean)
Constructs a new instance of a file to match elements that have a given phase status on the input phase, with the option to match all elements that have a phase status other than the input status.
Public Method
ElementPhaseStatusFilter(ElementId, ICollection.ElementOnPhaseStatus., Boolean)
Constructs a new instance of a file to match elements that have a given phase statuses on the input phase, with the option to match all elements that have a phase status other than the input statuses.
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
PhaseId
The phase id.
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
GetPhaseStatuses
Returns the phase statuses assigned to this filter.
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. Slow filters require that the Element be obtained and expanded in memory first. Thus it is preferable to couple this filter with at least one ElementQuickFilter, which should minimize the number of Elements that are expanded.