C# in a Nutshell, Second Edition

Name

ObsoleteAttribute

Synopsis

This attribute is used to mark program elements that will be removed in future versions or are no longer fully supported. The use of an element with this attribute (e.g., calling a method or setting a property marked with ObsoleteAttribute) causes a compile-time warning. You can set the Message property to supply a string to display to the user, typically specifying a workaround or the program element that should be used as a replacement. You can also use the IsError property to specify that the compiler treats the use of this element as an error. The default is false. These properties are set through the constructor, as in [Obsolete ("OldMethod has been replaced by NewMethod“, true)].

public sealed class ObsoleteAttribute : Attribute {
// Public Constructors
   public ObsoleteAttribute( );
   public ObsoleteAttribute(string message);
   public ObsoleteAttribute(string message, bool error);
// Public Instance Properties
   public bool IsError{get; }
   public string Message{get; }
}

Hierarchy

Object → Attribute → ObsoleteAttribute

Valid On

Class, Struct, Enum, Constructor, Method, Property, Field, Event, Interface, Delegate