CategoryAttribute Класс

Определение

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

System.ComponentModel

Сборки:

netstandard.dll, 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 свойство. Свойство имеет два атрибута: a DescriptionAttribute и a 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.
        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 класса с помощью имени категории Default.
CategoryAttribute(String)	Инициализирует новый экземпляр класса с помощью указанного CategoryAttribute имени категории.

Свойства

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

Методы

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

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

• Attribute
• PropertyDescriptor
• EventDescriptor