ObsoleteAttribute Classe

Definizione

Spazio dei nomi:

System

Assembly:

System.Runtime.dll

Source:

ObsoleteAttribute.cs

Contrassegna gli elementi del programma che non vengono più utilizzati. La classe non può essere ereditata.

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

Ereditarietà

Object

Attribute

ObsoleteAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene definita una classe che contiene una proprietà e un metodo contrassegnati con l'attributo ObsoleteAttribute . L'accesso al valore della OldProperty proprietà nel codice genera un avviso del compilatore, ma la chiamata al metodo genera un errore del CallOldMethod compilatore. L'esempio mostra anche l'output risultante quando si tenta di compilare il codice sorgente.

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())
'                            ~~~~~~~~~~~~~

Commenti

ObsoleteAttribute è applicabile a tutti gli elementi del programma ad eccezione di assembly, moduli, parametri e valori restituiti. Contrassegnare un elemento come obsoleto informa gli utenti che l'elemento può essere rimosso in una versione futura del prodotto.

La stringa assegnata alla Message proprietà viene generata dal compilatore quando la destinazione dell'attributo viene usata nel codice. Idealmente, la stringa deve fornire una soluzione alternativa o un'alternativa a livello di codice.

Utilizzare la IsError proprietà per indicare al compilatore se l'uso dell'attributo ObsoleteAttribute deve generare un errore ( è true) o un avviso (IsErrorIsError è false).

Per altre informazioni sull'uso degli attributi, vedere Attributi.

Costruttori

ObsoleteAttribute()	Inizializza una nuova istanza della classe ObsoleteAttribute con le proprietà predefinite.
ObsoleteAttribute(String)	Inizializza una nuova istanza della classe ObsoleteAttribute con un messaggio alternativo specificato.
ObsoleteAttribute(String, Boolean)	Inizializza una nuova istanza della classe ObsoleteAttribute con un messaggio alternativo e un valore Boolean che indica se l'utilizzo dell'elemento obsoleto viene considerato un errore.

Proprietà

DiagnosticId	Ottiene o imposta l'ID che verrà usato dal compilatore per segnalare un uso dell'API.
IsError	Ottiene un valore che indica se il compilatore considererà l'utilizzo dell'elemento di programma obsoleto come errore.
Message	Ottiene il messaggio di soluzione alternativa.
TypeId	Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)
UrlFormat	Ottiene o imposta l'URL per la documentazione corrispondente. L'API accetta una stringa di formato anziché un URL effettivo, creando un URL generico che include l'ID di diagnostica.

Metodi

Equals(Object)	Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
GetHashCode()	Restituisce il codice hash per l'istanza. (Ereditato da Attribute)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute)
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Vedi anche

• Attribute
• Estendere i metadati mediante attributi