ObsoleteAttribute Třída

Definice

Obor názvů:

System

Sestavení:

System.Runtime.dll

Source:

ObsoleteAttribute.cs

Označí prvky programu, které se už nepoužívají. Tato třída se nemůže dědit.

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

Dědičnost

Object

Attribute

ObsoleteAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad definuje třídu, která obsahuje vlastnost a metodu označenou atributem ObsoleteAttribute . Přístup k hodnotě OldProperty vlastnosti v kódu vygeneruje upozornění kompilátoru CallOldMethod , ale volání metody vygeneruje chybu kompilátoru. Příklad také ukazuje výstup, který se zobrazí při pokusu o kompilaci zdrojového kódu.

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

Poznámky

ObsoleteAttribute se vztahuje na všechny prvky programu s výjimkou sestavení, modulů, parametrů a návratových hodnot. Označení elementu jako zastaralého informuje uživatele, že prvek může být v budoucí verzi produktu odebrán.

Řetězec přiřazený vlastnosti Message je generován kompilátorem, když je cíl atributu použit v kódu. V ideálním případě by řetězec měl poskytovat nějaké alternativní řešení nebo programovou alternativu.

IsError Pomocí vlastnosti určete kompilátoru, jestli má použití atributu ObsoleteAttribute způsobit, že vygeneruje chybu (IsError je true) nebo upozornění (IsError je false).

Další informace o používání atributů najdete v tématu Atributy.

Konstruktory

ObsoleteAttribute()	Inicializuje novou instanci ObsoleteAttribute třídy s výchozími vlastnostmi.
ObsoleteAttribute(String)	Inicializuje novou instanci ObsoleteAttribute třídy se zadanou zprávou alternativního řešení.
ObsoleteAttribute(String, Boolean)	Inicializuje novou instanci ObsoleteAttribute třídy se zprávou alternativního řešení a logickou hodnotou označující, zda je použití zastaralého prvku považováno za chybu.

Vlastnosti

DiagnosticId	Získá nebo nastaví ID, které kompilátor použije při hlášení použití rozhraní API.
IsError	Získá hodnotu, která označuje, zda kompilátor bude považovat použití zastaralého prvku programu jako chybu.
Message	Získá zprávu o alternativním řešení.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tuto Attributetřídu . (Zděděno od Attribute)
UrlFormat	Získá nebo nastaví adresu URL pro odpovídající dokumentaci. Rozhraní API přijímá formátovací řetězec místo skutečné adresy URL a vytváří obecnou adresu URL, která obsahuje ID diagnostiky.

Metody

Equals(Object)	Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí hodnotu hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě označuje, zda je hodnota této instance výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• Attribute
• Rozšiřování metadat pomocí atributů