ScheduleDefinitionCanFilterBySubstring Method

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

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

Syntax

public bool CanFilterBySubstring(
	ScheduleFieldId fieldId
)

Public Function CanFilterBySubstring ( 
	fieldId As ScheduleFieldId
) As Boolean

public:
bool CanFilterBySubstring(
	ScheduleFieldId^ fieldId
)

member CanFilterBySubstring : 
        fieldId : ScheduleFieldId -> bool

Boolean
True if the field can be used with a substring-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

Remarks

The substring-based filter types are Contains, NotContains, BeginsWith, NonBeginsWith, EndsWith and NotEndsWith.

Only string parameters can be filtered by substring.