DescriptionAttribute Класс

Определение

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

System.ComponentModel

Сборка:

System.ComponentModel.Primitives.dll

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

DescriptionAttribute.cs

Задает описание для свойства или события.

public ref class DescriptionAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All)>]
type DescriptionAttribute = class
    inherit Attribute

Public Class DescriptionAttribute
Inherits Attribute

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

Object

Attribute

DescriptionAttribute

Производный

Microsoft.VisualBasic.Compatibility.VB6.SRDescriptionAttribute

System.Data.DataSysDescriptionAttribute

System.Diagnostics.MonitoringDescriptionAttribute

System.DirectoryServices.DSDescriptionAttribute

System.IO.IODescriptionAttribute

System.Messaging.MessagingDescriptionAttribute

System.ServiceProcess.ServiceProcessDescriptionAttribute

System.Timers.TimersDescriptionAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере создается MyImage свойство . Свойство имеет два атрибута DescriptionAttribute : и CategoryAttribute.

public:
   property Image^ MyImage 
   {
      [Description("The image associated with the control"),Category("Appearance")]
      Image^ get()
      {
         // Insert code here.
         return image1;
      }

      void set( Image^ value )
      {
         // Insert code here.
      }
   }

[Description("The image associated with the control"),Category("Appearance")] 
 public Image MyImage {
    get {
       // Insert code here.
       return image1;
    }
    set {
       // Insert code here.
    }
 }

<Description("The image associated with the control"), _
    Category("Appearance")> _
Public Property MyImage() As Image
    Get
        ' Insert code here.
        Return image1
    End Get
    Set
        ' Insert code here.
    End Set 
End Property

В следующем примере возвращается описание MyImage. Сначала код получает со PropertyDescriptorCollection всеми свойствами объекта . Затем он индексирует в , PropertyDescriptorCollection чтобы получить MyImage. Затем он возвращает атрибуты для этого свойства и сохраняет их в переменной атрибутов.

Затем в примере выводится описание, извлекая DescriptionAttribute его из AttributeCollection, и записывая его на экран консоли.

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this )[ "MyImage" ]->Attributes;

/* Prints the description by retrieving the DescriptionAttribute 
      * from the AttributeCollection. */
DescriptionAttribute^ myAttribute = dynamic_cast<DescriptionAttribute^>(attributes[ DescriptionAttribute::typeid ]);
Console::WriteLine( myAttribute->Description );

// Gets the attributes for the property.
 AttributeCollection attributes = 
    TypeDescriptor.GetProperties(this)["MyImage"].Attributes;
 
 /* Prints the description by retrieving the DescriptionAttribute 
  * from the AttributeCollection. */
 DescriptionAttribute myAttribute = 
    (DescriptionAttribute)attributes[typeof(DescriptionAttribute)];
 Console.WriteLine(myAttribute.Description);

' Gets the attributes for the property.
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("MyImage").Attributes

' Prints the description by retrieving the DescriptionAttribute
' from the AttributeCollection. 
Dim myAttribute As DescriptionAttribute = _
    CType(attributes(GetType(DescriptionAttribute)), DescriptionAttribute)
Console.WriteLine(myAttribute.Description)

Комментарии

Визуальный конструктор может отображать указанное описание при ссылке на элемент компонента, например в окно свойств. Вызовите Description для доступа к значению этого атрибута.

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

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

DescriptionAttribute()	Инициализирует новый экземпляр класса DescriptionAttribute без параметров.
DescriptionAttribute(String)	Инициализирует новый экземпляр класса DescriptionAttribute с указанным описанием.

Поля

Default

Определяет значение по умолчанию для атрибута DescriptionAttribute, являющееся пустой строкой (""). Это статическое (static) поле доступно только для чтения.

Свойства

Description	Возвращает описание, хранящееся в данном атрибуте.
DescriptionValue	Получает или задает строку, хранящуюся в качестве описания.
TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)

Методы

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

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

• Attribute
• PropertyDescriptor
• EventDescriptor