ContractOptionAttribute Class

ContractOptionAttribute Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Enables you to set contract and tool options at assembly, type, or method granularity.

System::Object
  System::Attribute
    System.Diagnostics.Contracts::ContractOptionAttribute

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

No code example is currently available or this language may not be supported.

The ContractOptionAttribute type exposes the following members.

  NameDescription
Public methodContractOptionAttribute(String, String, Boolean)Initializes a new instance of the ContractOptionAttribute class by using the provided category, setting, and enable/disable value.
Public methodContractOptionAttribute(String, String, String)Initializes a new instance of the ContractOptionAttribute class by using the provided category, setting, and value.
Top

  NameDescription
Public propertyCategoryGets the category of the option.
Public propertyEnabledDetermines if an option is enabled.
Public propertySettingGets the setting for the option.
Public propertyValueGets the value for the option.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The following table shows the currently supported options.

Category

Setting

Value/effect

contract

inheritance

true to turn contract inheritance on; false to turn it off. The default is true.

runtime

checking

true to turn run-time checking on; false to turn it off. The default is true.

You can use this attribute as illustrated in the following examples.

To turn off run-time checking for the entire assembly:

[assembly:ContractOption("runtime", "checking", false)]

To turn run-time contract checking on for a specific type:

   [ContractOption("runtime", "checking", true)]
   class TypeWithRuntimeChecking {
 
       ...

To turn run-time checking off for a specific method:

// Turn off all contract inheritance from interface IList<T>
[ContractOption("contract", "inheritance", false)]
class MyConcurrentList<T> : IList<T> {
   ...
}
 
[ContractOption("runtime", "checking", false)]
public override MyMethod(int x) {
   // no inherited contracts checked at runtime,
   // no invariants checked at runtime.
   ...
}
  
       [ContractOption("runtime", "checking", false)]
       public void MethodWithoutRuntimeChecking(...) {
          ...
       }
   }

Windows Phone OS

Supported in: 8.1, 8.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2017 Microsoft