Creates a filter rule that determines whether strings from the document begin with a certain string value.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 23.0.0.0 (23.1.0.0)
Since: 2011

Syntax

C#
[ObsoleteAttribute("This method is deprecated in Revit 2023 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")] public static FilterRule CreateBeginsWithRule( ElementId parameter, string value, bool caseSensitive )

[ObsoleteAttribute("This method is deprecated in Revit 2023 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")]
public static FilterRule CreateBeginsWithRule(
	ElementId parameter,
	string value,
	bool caseSensitive
)

Visual Basic

Visual Basic
<ObsoleteAttribute("This method is deprecated in Revit 2023 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")> _ Public Shared Function CreateBeginsWithRule ( _ parameter As ElementId, _ value As String, _ caseSensitive As Boolean _ ) As FilterRule

<ObsoleteAttribute("This method is deprecated in Revit 2023 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")> _
Public Shared Function CreateBeginsWithRule ( _
	parameter As ElementId, _
	value As String, _
	caseSensitive As Boolean _
) As FilterRule

Visual C++

Visual C++
[ObsoleteAttribute(L"This method is deprecated in Revit 2023 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")] public: static FilterRule^ CreateBeginsWithRule( ElementId^ parameter, String^ value, bool caseSensitive )

[ObsoleteAttribute(L"This method is deprecated in Revit 2023 and may be removed in a future version of Revit. Please use the constructor without the `caseSensitive` argument instead.")]
public:
static FilterRule^ CreateBeginsWithRule(
	ElementId^ parameter, 
	String^ value, 
	bool caseSensitive
)

Parameters

parameter: Type: Autodesk.Revit.DB ElementId
A string-typed parameter used to get values from the document for a given element.

value: Type: System String
The user-supplied string value for which values from the document will be searched.

caseSensitive: Type: System Boolean
If true, the string comparison will be case-sensitive.

Exceptions

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

CreateBeginsWithRule Method

Syntax

Parameters

Exceptions

See Also

Put AI to work inside Revit.