Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ContractOptionAttribute Class

.NET Framework 4.5

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)
[ConditionalAttribute("CONTRACTS_FULL")]
[AttributeUsageAttribute(AttributeTargets.All, AllowMultiple = true, Inherited = false)]
public sealed class ContractOptionAttribute : Attribute

The ContractOptionAttribute type exposes the following members.

  NameDescription
Public methodSupported in .NET for Windows Store appsContractOptionAttribute(String, String, Boolean)Initializes a new instance of the ContractOptionAttribute class by using the provided category, setting, and enable/disable value.
Public methodSupported in .NET for Windows Store appsContractOptionAttribute(String, String, String)Initializes a new instance of the ContractOptionAttribute class by using the provided category, setting, and value.
Top
  NameDescription
Public propertySupported in .NET for Windows Store appsCategoryGets the category of the option.
Public propertySupported in .NET for Windows Store appsEnabledDetermines if an option is enabled.
Public propertySupported in .NET for Windows Store appsSettingGets the setting for the option.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public propertySupported in .NET for Windows Store appsValueGets the value for the option.
Top
  NameDescription
Public methodSupported in .NET for Windows Store appsEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodSupported in .NET for Windows Store appsGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodSupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodSupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
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(...) {
          ...
       }
   }

.NET Framework

Supported in: 4.5.1, 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.