FilterStringRule Constructor


Constructs an instance of FilterStringRule.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 22.0.0.0 (22.1.0.0)
Since: 2011

Syntax

C#
[ObsoleteAttribute("This method is deprecated in Revit 2022 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")]
public FilterStringRule(
	FilterableValueProvider valueProvider,
	FilterStringRuleEvaluator evaluator,
	string ruleString,
	bool caseSensitive
)
Visual Basic
<ObsoleteAttribute("This method is deprecated in Revit 2022 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")> _
Public Sub New ( _
	valueProvider As FilterableValueProvider, _
	evaluator As FilterStringRuleEvaluator, _
	ruleString As String, _
	caseSensitive As Boolean _
)
Visual C++
[ObsoleteAttribute(L"This method is deprecated in Revit 2022 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")]
public:
FilterStringRule(
	FilterableValueProvider^ valueProvider, 
	FilterStringRuleEvaluator^ evaluator, 
	String^ ruleString, 
	bool caseSensitive
)

Parameters

valueProvider
Type: Autodesk.Revit.DB FilterableValueProvider
A pointer to a "value provider" object that will extract values from a Revit document.
evaluator
Type: Autodesk.Revit.DB FilterStringRuleEvaluator
A pointer to the filter rule evaluator object that implements the desired test. The built-in evaluators implement commonly used tests for strings such as begins-with, ends-with, contains, equal, etc.
ruleString
Type: System String
The user-supplied string against which strings from a Revit document will be tested.
caseSensitive
Type: System Boolean
If true, string comparisons will be done case-sensitively.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was null

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →