Marks the program elements that are no longer in use. This class cannot be inherited.
Assembly: mscorlib (in mscorlib.dll)
[SerializableAttribute] [AttributeUsageAttribute(AttributeTargets::Class|AttributeTargets::Struct|AttributeTargets::Enum|AttributeTargets::Constructor|AttributeTargets::Method|AttributeTargets::Property|AttributeTargets::Field|AttributeTargets::Event|AttributeTargets::Interface|AttributeTargets::Delegate, Inherited = false)] [ComVisibleAttribute(true)] public ref class ObsoleteAttribute sealed : public Attribute
Thetype exposes the following members.
|ObsoleteAttribute()||Initializes a new instance of the class with default properties.|
|ObsoleteAttribute(String)||Initializes a new instance of the class with a specified workaround message.|
|ObsoleteAttribute(String, Boolean)||Initializes a new instance of the class with a workaround message and a Boolean value indicating whether the obsolete element usage is considered an error.|
|IsError||Gets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error.|
|Message||Gets the workaround message, including a description of the alternative program elements.|
|TypeId||When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)|
|Equals||Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)|
|GetHashCode||Returns the hash code for this instance. (Inherited from Attribute.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|IsDefaultAttribute||When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)|
|Match||When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)|
|ToString||Returns a string that represents the current object. (Inherited from Object.)|
|_Attribute::GetIDsOfNames||Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)|
|_Attribute::GetTypeInfo||Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)|
|_Attribute::GetTypeInfoCount||Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)|
|_Attribute::Invoke||Provides access to properties and methods exposed by an object. (Inherited from Attribute.)|
is applicable to all program elements except assemblies, modules, parameters, and return values. Marking an element as obsolete informs users that the element will be removed in future versions of the product.
The class includes two properties:
Message. The string assigned to the Message property is emitted by the compiler when the attribute target is used in code. The string should note that the attribute target is obsolete and, if possible, provide some workaround or programmatic alternative.
For more information about using attributes, see Extending Metadata Using Attributes.
Windows Store Apps
When you create a Windows Metadata library (.winmd file), the is exported as both the attribute and the Windows.Foundation.Metadata.DeprecatedAttribute attribute if only the is present in source code. The is transformed to the DeprecatedAttribute as follows:
If the message and error arguments are both present, message is assigned to the DeprecatedAttribute message argument. An error value of true maps to DeprecationType.Remove, and an error value of false maps to DeprecationType.Deprecate.
If the message argument is not supplied in the , its default value in the DeprecatedAttribute is "element_name is deprecated", where element_name is the name of the target program element to which the attribute is applied.
If the error argument is not present in the , its default value in the DeprecatedAttribute is DeprecationType.Deprecate.
Directly applying the Windows.Foundation.Metadata.DeprecatedAttribute attribute to managed code is not recommended, because this export occurs automatically.
The following example defines a class that contains a property and a method that are marked with the attribute. Accessing the value of the OldProperty property in code generates a compiler warning, but calling the CallOldMethod method generates a compiler error. The example also shows the output that results when you attempt to compile the source code.
.NET FrameworkSupported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
Portable Class LibrarySupported in: Portable Class Library
.NET for Windows Store appsSupported in: Windows 8
.NET for Windows Phone appsSupported 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.