IsShorterOrEqual Method (ConditionValidator(String), Int32, String)

CuttingEdge.Conditions

Checks whether the given value is shorter or equal in length than maxLength. An exception is thrown otherwise. A null reference is considered to have a length of 0.

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

Syntax

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

Parameters

validator
Type: CuttingEdge.Conditions..::.ConditionValidator<(Of <(String>)>)
The ConditionValidator<(Of <(T>)>) that holds the value that has to be checked.
maxLength
Type: System..::.Int32
The biggest valid length.
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 length of the Value of the specified validator is smaller than maxLength, 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 maxLength is smaller than 0, while the specified validator is created using the Requires extension method.
CuttingEdge.Conditions..::.PostconditionExceptionThrown when the length of the Value of the specified validator is smaller than maxLength, while the specified validator is created using the Ensures extension method.

See Also