DescriptionAttribute Класс

Определение

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

System.ComponentModel

Сборка:

System.dll

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

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 свойство. Свойство имеет два атрибута, a DescriptionAttribute и a 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.
        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.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Извлекает сведения о типе объекта, который можно использовать для получения сведений о типе для интерфейса. (Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Предоставляет доступ к свойствам и методам, предоставляемым объектом. (Унаследовано от Attribute)

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

• Attribute
• PropertyDescriptor
• EventDescriptor