Поделиться через


Практическое руководство. Предоставление метаданных для свойств, методов и событий компонента

Используя атрибуты, можно присоединять к свойствам, методам и событиям описательные метаданные. Атрибуты представляют собой специализированные классы, которые модифицируют элементы кода и преобразуются в метаданные для этих элементов кода во время компиляции. Атрибуты времени разработки взаимодействуют со средой разработки, предоставляя разработчику сведения о компоненте. Примером часто используемого атрибута является DescriptionAttribute. При присоединении к свойству или событию атрибут DescriptionAttribute получает короткую строку, которая выводится на экран в окне Свойства. Ниже представлен пример.

Imports System.ComponentModel
<Description("This property specifies the active Widget")> Public _
   Property ActiveWidget as Widget
' Insert code to implementat functionality.
End Property
using System.ComponentModel;
[Description("This property specifies the active Widget")]
public Widget ActiveWidget
{
   // Insert code to implementat functionality.
}

Подробные сведения об атрибутах, которые можно использовать для расширения поддержки компонентов во время разработки, см. в разделе Атрибуты времени разработки для компонентов.

Чтобы присоединить атрибут к свойству, методу или событию, выполните следующие действия.

  • Добавьте вызов конструктора атрибута в элемент кода, который необходимо изменить. Вызов добавляется путем добавления угловых скобок <> (для Visual Basic) или квадратных скобок [] (для C#) перед элементом кода, который предполагается изменить.

    <Browsable(False)> Public Property ServingSize as Integer
    
    [Browsable(false)]
    public int ServingSize
    

См. также

Задачи

Практическое руководство. Предоставление описаний компонента в форме метаданных

Ссылки

Attribute

Основные понятия

Атрибуты времени разработки для компонентов

Доступ к пользовательским атрибутам

Извлечение информации, сохраненной в атрибуте

Другие ресурсы

Помощь пользователю по компонентам