ScheduleDefinition.CanFilterBySubstring Method

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


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

Syntax

C#

public bool CanFilterBySubstring(
	ScheduleFieldId fieldId
)

Parameters

fieldId  ScheduleFieldId
The ID of the field to check.

Return Value

Boolean
True if the field can be used with a substring-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 substring-based filter types are Contains, NotContains, BeginsWith, NonBeginsWith, EndsWith and NotEndsWith.

Only string parameters can be filtered by substring.

See Also

Reference

ScheduleDefinition Class
Autodesk.Revit.DB Namespace