DescriptionAttribute Класс

Определение

Задает описание для свойства или события.Specifies a description for a property or event.

public ref class DescriptionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attribute
type DescriptionAttribute = class
    inherit Attribute
Public Class DescriptionAttribute
Inherits Attribute
Наследование
DescriptionAttribute
Производный
Атрибуты

Примеры

В следующем примере создается MyImage свойство.The following example creates the MyImage property. Свойство имеет два атрибута: a DescriptionAttribute CategoryAttributeи.The property has two attributes, a DescriptionAttribute and 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.
       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.The next example gets the description of MyImage. Сначала код получает PropertyDescriptorCollection со всеми свойствами для объекта.First the code gets a PropertyDescriptorCollection with all the properties for the object. Затем он индексирует в, PropertyDescriptorCollection чтобы получить MyImage.Next it indexes into the PropertyDescriptorCollection to get MyImage. Затем он возвращает атрибуты для этого свойства и сохраняет их в переменной attributes.Then it returns the attributes for this property and saves them in the attributes variable.

Затем в примере выводится описание путем извлечения DescriptionAttribute AttributeCollectionиз и записи на экран консоли.The example then prints the description by retrieving DescriptionAttribute from the AttributeCollection, and writing it to the console screen.

// 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)

Комментарии

Визуальный конструктор может отображать указанное описание при ссылке на член компонента, например в окно свойств.A visual designer can display the specified description when referencing the component member, such as in a Properties window. Вызовите метод Description , чтобы получить значение этого атрибута.Call Description to access the value of this attribute.

Дополнительные сведения см. в разделе Атрибуты.For more information, see Attributes.

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

DescriptionAttribute()

Инициализирует новый экземпляр класса DescriptionAttribute без параметров.Initializes a new instance of the DescriptionAttribute class with no parameters.

DescriptionAttribute(String)

Инициализирует новый экземпляр класса DescriptionAttribute с указанным описанием.Initializes a new instance of the DescriptionAttribute class with a description.

Поля

Default

Определяет значение по умолчанию для атрибута DescriptionAttribute, являющееся пустой строкой ("").Specifies the default value for the DescriptionAttribute, which is an empty string (""). Это статическое (static) поле доступно только для чтения.This static field is read-only.

Свойства

Description

Возвращает описание, хранящееся в данном атрибуте.Gets the description stored in this attribute.

DescriptionValue

Получает или задает строку, хранящуюся в качестве описания.Gets or sets the string stored as the description.

TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Унаследовано от Attribute)

Методы

Equals(Object)

Возвращает значение, показывающее, равно ли значение данного объекта текущему атрибуту DescriptionAttribute.Returns whether the value of the given object is equal to the current DescriptionAttribute.

GetHashCode()

Возвращает хэш-код данного экземпляра.Returns the hash code for this instance.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
IsDefaultAttribute()

Возвращает значение, показывающее, является ли этот атрибут DescriptionAttribute экземпляром по умолчанию.Returns a value indicating whether this is the default DescriptionAttribute instance.

Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Унаследовано от Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Унаследовано от Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Унаследовано от Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Унаследовано от Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Унаследовано от Attribute)

Применяется к

Дополнительно