Namespace: Autodesk.Revit.DB Class: ScheduleDefinition

ScheduleDefinition.CanFilterBySubstring

Method

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

Remarks:

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

Only string parameters can be filtered by substring.

Syntax

public bool CanFilterBySubstring(
	ScheduleFieldId fieldId
)

Public Function CanFilterBySubstring ( 
	fieldId As ScheduleFieldId
) As Boolean

public:
bool CanFilterBySubstring(
	ScheduleFieldId^ fieldId
)

member CanFilterBySubstring : 
        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 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