ScheduleFilter

Public Class

A filter in a schedule.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ScheduleFilter

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class ScheduleFilter : IDisposable

The ScheduleFilter type exposes the following members.

Constructors

Name

Description

---

Public Method
ScheduleFilter.

Creates a new ScheduleFilter.

---

Public Method
ScheduleFilter(ScheduleFieldId, ScheduleFilterType)

Creates a new ScheduleFilter.

---

Public Method
ScheduleFilter(ScheduleFieldId, ScheduleFilterType, ElementId)

Creates a new ScheduleFilter.

---

Public Method
ScheduleFilter(ScheduleFieldId, ScheduleFilterType, Double)

Creates a new ScheduleFilter.

---

Public Method
ScheduleFilter(ScheduleFieldId, ScheduleFilterType, Int32)

Creates a new ScheduleFilter.

---

Public Method
ScheduleFilter(ScheduleFieldId, ScheduleFilterType, String)

Creates a new ScheduleFilter.

---

Properties

Name

Description

---

Public Property

FieldId

The ID of the field used to filter the schedule.

---

Public Property
FilterType

The filter type.

---

Public Property

IsDoubleValue

Indicates if the filter has a double value.

---

Public Property

IsElementIdValue

Indicates if the filter has an ElementId value.

---

Public Property

IsIntegerValue

Indicates if the filter has an integer value.

---

Public Property

IsNullValue

Indicates if the filter has no specified value.

---

Public Property

IsStringValue

Indicates if the filter has a string value.

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Methods

Name

Description

---

Public Method

Dispose

Releases all resources used by the ScheduleFilter

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method

GetDoubleValue

Gets the filter value for a filter using a double value.

---

Public Method

GetElementIdValue

Gets the filter value for a filter using an ElementId value.

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetIntegerValue

Gets the filter value for a filter using an integer value.

---

Public Method

GetStringValue

Gets the filter value for a filter using a string value.

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

SetNullValue

Sets the filter to have no specified value (used for HasParameter filters).

---

Public Method

SetValue(Double)

Set the filter value to a double.

---

Public Method

SetValue(ElementId)

Set the filter value to an ElementId.

---

Public Method

SetValue(Int32)

Set the filter value to an integer.

---

Public Method

SetValue(String)

Set the filter value to a string.

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Remarks

The ScheduleFilter class represents a single filter in a schedule. A filter is a condition that must be satisfied for an element to appear in the schedule. All filters must be satisfied for an element to appear in the schedule.

A schedule can be filtered by data that is not displayed in the schedule by marking the field used for filtering as hidden using the ScheduleField.IsHidden property.