Share

ScheduleDefinition.CanFilterByValue Method

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


Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.3.0.0 (26.3.0.0)

Syntax

C#

public bool CanFilterByValue(
	ScheduleFieldId fieldId
)

Parameters

fieldId  ScheduleFieldId
The ID of the field to check.

Return Value

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

Exceptions

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

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.

See Also

Reference

Was this information helpful?