CategoryAttribute Класс

Определение

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

System.ComponentModel

Сборка:

System.ComponentModel.Primitives.dll

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

CategoryAttribute.cs

Задает имя категории, в которой при отображении в элементе управления PropertyGrid для группировки свойств или событий установлен режим "По категориям".

public ref class CategoryAttribute : Attribute

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

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

Public Class CategoryAttribute
Inherits Attribute

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

Object

Attribute

CategoryAttribute

Атрибуты

AttributeUsageAttribute

Примеры

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

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

   void set( System::Drawing::Image^ )
   {
      // 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. Затем он возвращает атрибуты для этого свойства и сохраняет их в переменной attributes.

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

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

// Prints the description by retrieving the CategoryAttribute.
// from the AttributeCollection.
CategoryAttribute^ myAttribute = static_cast<CategoryAttribute^>(attributes[ CategoryAttribute::typeid ]);
Console::WriteLine( myAttribute->Category );

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

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

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

Комментарии

Указывает CategoryAttribute категорию, с которой связывается связанное свойство или событие при перечислении свойств или событий в элементе управления, заданном PropertyGridCategorized в режиме . Если объект CategoryAttribute не был применен к свойству или событию PropertyGrid , класс связывает его с категорией Misc . Новую категорию можно создать для любого имени, указав имя категории в конструкторе CategoryAttributeдля .

Свойство Category указывает имя категории, которую представляет атрибут. Свойство Category также обеспечивает прозрачную локализацию имен категорий.

Примечания для тех, кто наследует этот метод

Если вы используете GetLocalizedString(String) имена категорий, отличные от предопределенных, и хотите локализовать имена категорий, необходимо переопределить метод .

Класс CategoryAttribute определяет следующие общие категории:

Категория	Описание
Action	Свойства, связанные с доступными действиями.
Appearance	Свойства, связанные с тем, как отображается сущность.
Behavior	Свойства, связанные с действиями сущности.
Data	Свойства, связанные с управлением данными и источниками данных.
Default	Свойства, сгруппированные в категорию по умолчанию.
Design	Свойства, доступные только во время разработки.
DragDrop	Свойства, связанные с операциями перетаскивания.
Focus	Свойства, связанные с фокусом.
Format	Свойства, связанные с форматированием.
Key	Свойства, связанные с клавиатурой.
Layout	Свойства, связанные с макетом.
Mouse	Свойства, связанные с мышью.
WindowStyle	Свойства, связанные со стилем окна форм верхнего уровня.

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

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

CategoryAttribute()	Инициализирует новый экземпляр класса CategoryAttribute с использованием имени категории "По умолчанию".
CategoryAttribute(String)	Выполняет инициализацию нового экземпляра класса CategoryAttribute, используя заданное имя категории.

Свойства

Action	Возвращает атрибут CategoryAttribute, представляющий категорию "Действие".
Appearance	Возвращает атрибут CategoryAttribute, представляющий категорию "Внешний вид".
Asynchronous	Возвращает атрибут CategoryAttribute, представляющий категорию "Асинхронная".
Behavior	Возвращает атрибут CategoryAttribute, представляющий категорию "Поведение".
Category	Возвращает имя категории для свойства или события, к которым применяется этот атрибут.
Data	Возвращает атрибут CategoryAttribute, представляющий категорию "Данные".
Default	Возвращает атрибут CategoryAttribute, представляющий категорию "По умолчанию".
Design	Возвращает атрибут CategoryAttribute, представляющий категорию "Конструктор".
DragDrop	Возвращает атрибут CategoryAttribute, представляющий категорию "Перетаскивание".
Focus	Получает атрибут CategoryAttribute, представляющий категорию "Фокус".
Format	Возвращает атрибут CategoryAttribute, представляющий категорию "Формат".
Key	Получает атрибут CategoryAttribute, представляющий категорию "Клавиша".
Layout	Возвращает атрибут CategoryAttribute, представляющий категорию "Структура".
Mouse	Возвращает атрибут CategoryAttribute, представляющий категорию "Мышь".
TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)
WindowStyle	Возвращает атрибут CategoryAttribute, представляющий категорию "Стиль окна".

Методы

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

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

• Attribute
• PropertyDescriptor
• EventDescriptor