ObsoleteAttribute Classe

Définition

Espace de noms:

System

Assembly:

System.Runtime.dll

Source:

ObsoleteAttribute.cs

Marque les éléments de programme qui ne sont plus utilisés. Cette classe ne peut pas être héritée.

public ref class ObsoleteAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Struct, Inherited=false)>]
type ObsoleteAttribute = class
    inherit Attribute

Public NotInheritable Class ObsoleteAttribute
Inherits Attribute

Héritage

Object

Attribute

ObsoleteAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant définit une classe qui contient une propriété et une méthode marquées avec l’attribut ObsoleteAttribute . L’accès à la valeur de la propriété dans le OldProperty code génère un avertissement du compilateur, mais l’appel de la CallOldMethod méthode génère une erreur du compilateur. L’exemple montre également la sortie qui se produit lorsque vous tentez de compiler le code source.

using System;
using System.Reflection;

public class Example
{
   // Mark OldProperty As Obsolete.
   [ObsoleteAttribute("This property is obsolete. Use NewProperty instead.", false)]
   public static string OldProperty
   { get { return "The old property value."; } }

   public static string NewProperty
   { get { return "The new property value."; } }

   // Mark CallOldMethod As Obsolete.
   [ObsoleteAttribute("This method is obsolete. Call CallNewMethod instead.", true)]
   public static string CallOldMethod()
   {
      return "You have called CallOldMethod.";
   }

   public static string CallNewMethod()
   {
      return "You have called CallNewMethod.";
   }

   public static void Main()
   {
      Console.WriteLine(OldProperty);
      Console.WriteLine();
      Console.WriteLine(CallOldMethod());
   }
}
// The attempt to compile this example produces output like the following output:
//    Example.cs(31,25): error CS0619: 'Example.CallOldMethod()' is obsolete:
//            'This method is obsolete. Call CallNewMethod instead.'
//    Example.cs(29,25): warning CS0618: 'Example.OldProperty' is obsolete:
//            'This property is obsolete. Use NewProperty instead.'

open System

// Mark oldValue As Obsolete.
[<ObsoleteAttribute("This value is obsolete. Use newValue instead.", false)>]
let oldValue =
    "The old property value."

let newValue =
    "The new property value."

// Mark callOldFunction As Obsolete.
[<ObsoleteAttribute("This function is obsolete. Call callNewFunction instead.", true)>]
let callOldFunction () =
    "You have called CallOldMethod."

let callNewFunction () =
    "You have called CallNewMethod."

printfn $"{oldValue}"
printfn ""
printfn $"{callOldFunction ()}"
// The attempt to compile this example produces output like the following output:
//    Example.fs(23,12): error FS0101: This construct is deprecated. This function is obsolete. Call callNewFunction instead.
//    Example.fs(21,12): warning FS0044: This construct is deprecated. This value is obsolete. Use newValue instead.

Imports System.Reflection

Public Module Example
   ' Mark OldProperty As Obsolete.
   <ObsoleteAttribute("This property is obsolete. Use NewProperty instead.", False)> 
   Public ReadOnly Property OldProperty As String
      Get
         Return "The old property value."
      End Get
   End Property
   
   Public ReadOnly Property NewProperty As String
      Get
         Return "The new property value."
      End Get
   End Property
   
   ' Mark OldMethod As Obsolete.
   <ObsoleteAttribute("This method is obsolete. Call CallNewMethod instead.", True)> 
   Public Function CallOldMethod() As String
      Return "You have called CallOldMethod."
   End Function
      
   Public Function CallNewMethod() As String   
      Return "You have called NewMethod."
   End Function   
   
   Public Sub Main()
      Console.WriteLine(OldProperty)
      Console.WriteLine()
      Console.WriteLine(CallOldMethod())
   End Sub  
End Module
'  The attempt to compile this example produces output like the following:
'    Example.vb(30) : warning BC40000: 'Public ReadOnly Property OldProperty As String' is obsolete: 
'                     'This property is obsolete. Use NewProperty instead.'.
'    
'          Console.WriteLine(OldProperty)
'                            ~~~~~~~~~~~
'    Example.vb(32) : error BC30668: 'Public Function CallOldMethod() As String' is obsolete: 
'                     'This method is obsolete. Call CallNewMethod instead.'.
'    
'          Console.WriteLine(CallOldMethod())
'                            ~~~~~~~~~~~~~

Remarques

ObsoleteAttribute s’applique à tous les éléments de programme, à l’exception des assemblys, des modules, des paramètres et des valeurs de retour. Le marquage d’un élément comme obsolète informe les utilisateurs que l’élément peut être supprimé dans une version ultérieure du produit.

La chaîne affectée à la Message propriété est émise par le compilateur lorsque la cible d’attribut est utilisée dans le code. Dans l’idéal, la chaîne doit fournir une solution de contournement ou une alternative programmatique.

Utilisez la IsError propriété pour indiquer au compilateur si l’utilisation de l’attribut ObsoleteAttribute doit provoquer l’émission d’une erreur (IsError est true) ou d’un avertissement (IsError est false).

Pour plus d’informations sur l’utilisation des attributs, consultez Attributs.

Constructeurs

ObsoleteAttribute()	Initialise une nouvelle instance de la classe ObsoleteAttribute avec des propriétés par défaut.
ObsoleteAttribute(String)	Initialise une nouvelle instance de la classe ObsoleteAttribute avec un message de solution spécifié.
ObsoleteAttribute(String, Boolean)	Initialise une nouvelle instance de la classe ObsoleteAttribute avec un message de solution et une valeur Boolean indiquant si l'utilisation de l'élément obsolète est considérée comme une erreur.

Propriétés

DiagnosticId	Obtient ou définit l’ID que le compilateur utilisera pour signaler une utilisation de l’API.
IsError	Obtient une valeur indiquant si le compilateur va traiter l’utilisation de l’élément de programme obsolète comme erreur.
Message	Obtient le message de la solution de contournement.
TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)
UrlFormat	Obtient ou définit l’URL de la documentation correspondante. L’API accepte une chaîne de format au lieu d’une URL réelle et crée une URL générique qui comprend l’ID de diagnostic.

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• Attribute
• Étendre des métadonnées en utilisant des attributs