ScheduleFilter

Description:
A filter in a schedule.

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.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.ScheduleFilter

public class ScheduleFilter : IDisposable

Public Class ScheduleFilter _
	Implements IDisposable

public ref class ScheduleFilter : IDisposable

Name	Return Type	Description
C ScheduleFilter()	None	Creates a new ScheduleFilter.
C ScheduleFilter(ScheduleFieldId, ScheduleFilterType)	None	Creates a new ScheduleFilter.
C ScheduleFilter(ScheduleFieldId, ScheduleFilterType, Double)	None	Creates a new ScheduleFilter.
C ScheduleFilter(ScheduleFieldId, ScheduleFilterType, ElementId)	None	Creates a new ScheduleFilter.
C ScheduleFilter(ScheduleFieldId, ScheduleFilterType, Int32)	None	Creates a new ScheduleFilter.
C ScheduleFilter(ScheduleFieldId, ScheduleFilterType, String)	None	Creates a new ScheduleFilter.

Name	Return Type	Description
M Dispose()	None	Releases all resources used by the
M GetDoubleValue()	The filter value.	Gets the filter value for a filter using a double value.
M GetElementIdValue()	The filter value.	Gets the filter value for a filter using an ElementId value.
M GetIntegerValue()	The filter value.	Gets the filter value for a filter using an integer value.
M GetStringValue()	The filter value.	Gets the filter value for a filter using a string value.
M SetNullValue()	None	Sets the filter to have no specified value (used for HasParameter filters).
M SetValue(Double)	None	Set the filter value to a double.
M SetValue(ElementId)	None	Set the filter value to an ElementId.
M SetValue(Int32)	None	Set the filter value to an integer.
M SetValue(String)	None	Set the filter value to a string.

Name	Return Type	Description
P FieldId	ScheduleFieldId	The ID of the field used to filter the schedule.
P FilterType	ScheduleFilterType	The filter type.
P IsDoubleValue	bool	Indicates if the filter has a double value.
P IsElementIdValue	bool	Indicates if the filter has an ElementId value.
P IsIntegerValue	bool	Indicates if the filter has an integer value.
P IsNullValue	bool	Indicates if the filter has no specified value.
P IsStringValue	bool	Indicates if the filter has a string value.
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.