DescriptionAttribute Класс
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Задает описание для свойства или события.
public ref class DescriptionAttribute : Attribute[System.AttributeUsage(System.AttributeTargets.All)]
public class DescriptionAttribute : Attributepublic class DescriptionAttribute : Attribute[<System.AttributeUsage(System.AttributeTargets.All)>]
type DescriptionAttribute = class
inherit Attributetype DescriptionAttribute = class
inherit AttributePublic Class DescriptionAttribute
Inherits Attribute- Наследование
- Производный
- Атрибуты
В следующем примере создается 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 для доступа к значению этого атрибута.
Дополнительные сведения см. в разделе Атрибуты.
|
Description |
Инициализирует новый экземпляр класса DescriptionAttribute без параметров. |
|
Description |
Инициализирует новый экземпляр класса DescriptionAttribute с указанным описанием. |
| Default |
Определяет значение по умолчанию для атрибута DescriptionAttribute, являющееся пустой строкой (""). Это статическое ( |
| Description |
Возвращает описание, хранящееся в данном атрибуте. |
|
Description |
Получает или задает строку, хранящуюся в качестве описания. |
|
Type |
В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute) |
| Equals(Object) |
Возвращает значение, показывающее, равно ли значение данного объекта текущему атрибуту DescriptionAttribute. |
|
Get |
Возвращает хэш-код данного экземпляра. |
|
Get |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
|
Is |
Возвращает значение, показывающее, является ли этот атрибут DescriptionAttribute экземпляром по умолчанию. |
|
Is |
При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute) |
| Match(Object) |
При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute) |
|
Memberwise |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
|
To |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
|
_Attribute. |
Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации. (Унаследовано от Attribute) |
|
_Attribute. |
Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса. (Унаследовано от Attribute) |
|
_Attribute. |
Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1). (Унаследовано от Attribute) |
|
_Attribute. |
Предоставляет доступ к открытым свойствам и методам объекта. (Унаследовано от Attribute) |
