Namespace: Autodesk.Revit.DB Class: ScheduleDefinition

ScheduleDefinition.CanFilterByValue

Method

Description:
Checks whether a field can be used with a value-based filter.

Remarks:

The value-based filter types are Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

Only certain types of parameters can be filtered by value.

Note that some fields (for example, Workset, Family, Type, Family and Type) only support Equal, NotEqual, but not GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

Syntax

public bool CanFilterByValue(
	ScheduleFieldId fieldId
)

Public Function CanFilterByValue ( 
	fieldId As ScheduleFieldId
) As Boolean

public:
bool CanFilterByValue(
	ScheduleFieldId^ fieldId
)

member CanFilterByValue : 
        fieldId : ScheduleFieldId -> bool

Parameters

Parameter	Type	Description
fieldId	ScheduleFieldId	The ID of the field to check.

Return Value

Type	Description
Boolean	True if the field can be used with a value based filter, false otherwise.

Exceptions

Exception	Condition
ArgumentException	fieldId is not the ID of a field in this ScheduleDefinition.
ArgumentNullException	A non-optional argument was null