ObsoleteAttribute Class

May 11, 2014

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

System.Object
  System.Attribute
    System.ObsoleteAttribute

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

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

The ObsoleteAttribute type exposes the following members.

  NameDescription
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.
Top

  NameDescription
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.
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

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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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:
© 2014 Microsoft