ObsoleteAttribute Klasa

Definicja

Przestrzeń nazw:

System

Zestaw:

System.Runtime.dll

Źródło:

ObsoleteAttribute.cs

Oznacza elementy programu, które nie są już używane. Klasa ta nie może być dziedziczona.

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

Dziedziczenie

Object

Attribute

ObsoleteAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

W poniższym przykładzie zdefiniowano klasę zawierającą właściwość i metodę oznaczoną atrybutem ObsoleteAttribute . Uzyskanie dostępu do wartości OldProperty właściwości w kodzie powoduje wygenerowanie ostrzeżenia kompilatora, ale wywołanie CallOldMethod metody generuje błąd kompilatora. W przykładzie przedstawiono również dane wyjściowe, które są wyświetlane podczas próby skompilowania kodu źródłowego.

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

Uwagi

ObsoleteAttribute dotyczy wszystkich elementów programu z wyjątkiem zestawów, modułów, parametrów i zwracanych wartości. Oznaczanie elementu jako przestarzałe informuje użytkowników, że element może zostać usunięty w przyszłej wersji produktu.

Ciąg przypisany do Message właściwości jest emitowany przez kompilator, gdy element docelowy atrybutu jest używany w kodzie. W idealnym przypadku ciąg powinien zapewnić obejście lub alternatywę programową.

IsError Użyj właściwości , aby wskazać kompilatorowi, czy użycie atrybutu ObsoleteAttribute powinno spowodować, że emituje błąd (IsError jest true) lub ostrzeżenie (IsError jest false).

Aby uzyskać więcej informacji na temat używania atrybutów, zobacz Atrybuty.

Konstruktory

ObsoleteAttribute()	Inicjuje ObsoleteAttribute nowe wystąpienie klasy z domyślnymi właściwościami.
ObsoleteAttribute(String)	Inicjuje ObsoleteAttribute nowe wystąpienie klasy z określonym komunikatem obejścia.
ObsoleteAttribute(String, Boolean)	Inicjuje nowe wystąpienie ObsoleteAttribute klasy z komunikatem obejścia i wartością logiczną wskazującą, czy przestarzałe użycie elementu jest uznawane za błąd.

Właściwości

DiagnosticId	Pobiera lub ustawia identyfikator używany przez kompilator podczas raportowania użycia interfejsu API.
IsError	Pobiera wartość wskazującą, czy kompilator będzie traktować użycie przestarzałego elementu programu jako błąd.
Message	Pobiera komunikat obejścia.
TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego elementu Attribute. (Odziedziczone po Attribute)
UrlFormat	Pobiera lub ustawia adres URL odpowiedniej dokumentacji. Interfejs API akceptuje ciąg formatu zamiast rzeczywistego adresu URL, tworząc ogólny adres URL zawierający identyfikator diagnostyczny.

Metody

Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi. (Odziedziczone po Attribute)
GetHashCode()	Zwraca wartość skrótu dla tego wystąpienia. (Odziedziczone po Attribute)
GetType()	Type Pobiera bieżące wystąpienie. (Odziedziczone po Object)
IsDefaultAttribute()	W przypadku zastąpienia w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej. (Odziedziczone po Attribute)
Match(Object)	W przypadku zastąpienia w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• Attribute
• Rozszerzanie metadanych przy użyciu atrybutów