Contract.Requires Method (Boolean, String)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Specifies a precondition contract for the enclosing method or property, and displays a message if the condition for the contract fails.

Namespace:  System.Diagnostics.Contracts
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
<ConditionalAttribute("CONTRACTS_FULL")> _
Public Shared Sub Requires ( _
    condition As Boolean, _
    userMessage As String _
)
[ConditionalAttribute("CONTRACTS_FULL")]
public static void Requires(
    bool condition,
    string userMessage
)

Parameters

  • userMessage
    Type: System.String
    The message to display if the condition is false.

Remarks

  • This method call must be at the beginning of a method or property, before any other code.

  • This contract is exposed to clients; therefore, it must only reference members that are at least as visible as the enclosing method.

  • Use this method instead of the Contract.Requires<TException>(Boolean, String) method when backward compatibility does not force you to throw a particular exception.

Version Information

Silverlight

Supported in: 5, 4

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.