StartsWith Method (ConditionValidator(String), String, String)

CuttingEdge.Conditions

Checks whether the given value starts with the specified value. An exception is thrown otherwise.

Namespace:  CuttingEdge.Conditions
Assembly:  CuttingEdge.Conditions (in CuttingEdge.Conditions.dll)

Syntax

Visual Basic (Declaration)
Public Shared Function StartsWith ( _
	validator As ConditionValidator(Of String), _
	value As String, _
	conditionDescription As String _
) As ConditionValidator(Of String)
C#
public static ConditionValidator<string> StartsWith(
	ConditionValidator<string> validator,
	string value,
	string conditionDescription
)
Visual C++
public:
static ConditionValidator<String^>^ StartsWith(
	ConditionValidator<String^>^ validator, 
	String^ value, 
	String^ conditionDescription
)
JavaScript
CuttingEdge.Conditions.ValidatorExtensions.startsWith = function(validator, value, conditionDescription);

Parameters

validator
Type: CuttingEdge.Conditions..::.ConditionValidator<(Of <(String>)>)
The ConditionValidator<(Of <(T>)>) that holds the value that has to be checked.
value
Type: System..::.String
The value to compare.
conditionDescription
Type: System..::.String
The description of the condition that should hold. The string may hold the placeholder '{0}' for the ArgumentName.

Return Value

The specified validator instance.

Exceptions

ExceptionCondition
System..::.ArgumentExceptionThrown when the Value of the specified validator does not start with value, while the specified validator is created using the Requires extension method.
System..::.ArgumentNullExceptionThrown when the Value of the specified validator is a null reference and value is not a null reference, while the specified validator is created using the Requires extension method.
CuttingEdge.Conditions..::.PostconditionExceptionThrown when the Value of the specified validator does not start with value, while the specified validator is created using the Ensures extension method.

See Also