ObsoleteAttribute Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Marks the program elements that are no longer in use. This class cannot be inherited.


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

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Constructor|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Event|AttributeTargets.Interface|AttributeTargets.Delegate, Inherited = false)]
public sealed class ObsoleteAttribute : Attribute

The ObsoleteAttribute type exposes the following members.

Public methodObsoleteAttribute()()()()Initializes a new instance of the ObsoleteAttribute class with default properties.
Public methodObsoleteAttribute(String)Initializes a new instance of the ObsoleteAttribute class with a specified workaround message.
Public methodObsoleteAttribute(String, Boolean)Initializes a new instance of the ObsoleteAttribute class with a workaround message and a Boolean value indicating whether the obsolete element usage is considered an error.

Public propertyIsErrorGets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error.
Public propertyMessageGets the workaround message, including a description of the alternative program elements.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

ObsoleteAttribute is applicable to all program elements except assemblies, modules, parameters or return values. Marking an element as obsolete informs the users that the element will be removed in future versions of the product.

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