ObsoleteAttribute Класс

Определение

Пространство имен:

System

Сборка:

System.Runtime.dll

Исходный код:

ObsoleteAttribute.cs

Отмечает элементы программы, которые больше не используются. Этот класс не наследуется.

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

Наследование

Object

Attribute

ObsoleteAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере определяется класс, содержащий свойство и метод, помеченные атрибутом ObsoleteAttribute . При доступе к значению OldProperty свойства в коде создается предупреждение компилятора, но при вызове CallOldMethod метода возникает ошибка компилятора. В примере также показаны выходные данные, полученные при попытке компиляции исходного кода.

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

Комментарии

ObsoleteAttribute применяется ко всем элементам программы, кроме сборок, модулей, параметров и возвращаемых значений. Пометка элемента как устаревшего сообщает пользователям, что элемент может быть удален в будущей версии продукта.

Строка, назначенная свойству Message , создается компилятором при использовании целевого объекта атрибута в коде. В идеале строка должна предоставлять некоторое обходное решение или программную альтернативу.

Используйте свойство , IsError чтобы указать компилятору, должно ли использование ObsoleteAttribute атрибута вызывать ошибку (IsError имеет значение true) или предупреждение (IsError имеет значение false).

Дополнительные сведения об использовании атрибутов см. в разделе Атрибуты.

Конструкторы

ObsoleteAttribute()	Инициализирует новый экземпляр класса ObsoleteAttribute стандартными свойствами.
ObsoleteAttribute(String)	Инициализирует новый экземпляр класса ObsoleteAttribute указанным сообщением об обходном пути.
ObsoleteAttribute(String, Boolean)	Инициализирует новый экземпляр класса ObsoleteAttribute сообщением об обходном пути и логическим значением, позволяющим определить, следует ли считать использование устаревшего элемента ошибкой.

Свойства

DiagnosticId	Возвращает или задает идентификатор, который будет использоваться компилятором при передаче данных об использовании API.
IsError	Возвращает значение, позволяющее определить, будет ли компилятор считать использование устаревшего элемента программы ошибкой.
Message	Возвращает сообщение обходного решения.
TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)
UrlFormat	Возвращает или задает URL-адрес соответствующей документации. API принимает формат строки вместо фактического URL-адреса, создавая универсальный URL-адрес, содержащий диагностический идентификатор.

Методы

Equals(Object)	Возвращает значение, показывающее, равен ли экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код данного экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• Attribute
• Расширение метаданных с помощью атрибутов