|
|
| CuttingEdge.Conditions reference library |
| ValidatorExtensions..::.IsTrue Method (ConditionValidator<(Of <(Nullable<(Of <(Boolean>)>)>)>), String) |
| ValidatorExtensions Class See Also Send Feedback |
Checks whether the given value is true. An exception is thrown otherwise.
Namespace:
CuttingEdge.Conditions
Assembly:
CuttingEdge.Conditions (in CuttingEdge.Conditions.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Public Shared Function IsTrue ( _ validator As ConditionValidator(Of Nullable(Of Boolean)), _ conditionDescription As String _ ) As ConditionValidator(Of Nullable(Of Boolean)) |
| C# |
|---|
public static ConditionValidator<Nullable<bool>> IsTrue( ConditionValidator<Nullable<bool>> validator, string conditionDescription ) |
| Visual C++ |
|---|
public: static ConditionValidator<Nullable<bool>>^ IsTrue( ConditionValidator<Nullable<bool>>^ validator, String^ conditionDescription ) |
| JavaScript |
|---|
CuttingEdge.Conditions.ValidatorExtensions.isTrue = function(validator, conditionDescription); |
Parameters
- validator
- Type: CuttingEdge.Conditions..::.ConditionValidator<(Of <(Nullable<(Of <(Boolean>)>)>)>)
The ConditionValidator<(Of <(T>)>) that holds the value that has to be checked.
- 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
| Exception | Condition |
|---|---|
| System..::.ArgumentException | Thrown when the Value of the specified validator is false or null, while the specified validator is created using the Requires extension method. |
| CuttingEdge.Conditions..::.PostconditionException | Thrown when the Value of the specified validator is false or null, while the specified validator is created using the Ensures extension method. |
See Also
