CategoryAttribute Class

Definition

Задает имя категории, в которой при отображении в элементе управления PropertyGrid для группировки свойств или событий установлен режим "По категориям".Specifies the name of the category in which to group the property or event when displayed in a PropertyGrid control set to Categorized mode.

public ref class CategoryAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class CategoryAttribute : Attribute
public class CategoryAttribute : Attribute
type CategoryAttribute = class
    inherit Attribute
Public Class CategoryAttribute
Inherits Attribute
Inheritance
CategoryAttribute
Attributes

Examples

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

Затем в примере выводится Категория путем извлечения CategoryAttribute из AttributeCollectionи записи ее на экран консоли.The example then prints the category by retrieving CategoryAttribute 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 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)

Remarks

CategoryAttribute указывает категорию, которая связывает связанное свойство или событие с, если список свойств или событий в элементе управления PropertyGrid установлен в режим Categorized.A CategoryAttribute indicates the category to associate the associated property or event with, when listing properties or events in a PropertyGrid control set to Categorized mode. Если CategoryAttribute не было применено к свойству или событию, PropertyGrid связывает его с категорией " Прочие ".If a CategoryAttribute has not been applied to a property or event, the PropertyGrid associates it with the Misc category. Новую категорию можно создать для любого имени, указав имя категории в конструкторе для CategoryAttribute.A new category can be created for any name by specifying the name of the category in the constructor for the CategoryAttribute.

Свойство Category указывает имя категории, которую представляет атрибут.The Category property indicates the name of the category that the attribute represents. Свойство Category также обеспечивает прозрачную локализацию имен категорий.The Category property also provides transparent localization of category names.

Notes to Inheritors

При использовании имен категорий, отличных от предопределенных имен, и необходимости локализации имен категорий необходимо переопределить метод GetLocalizedString(String).If you use category names other than the predefined names, and you want to localize your category names, you must override the GetLocalizedString(String) method.

Класс CategoryAttribute определяет следующие общие категории:The CategoryAttribute class defines the following common categories:

КатегорияCategory DescriptionDescription
Action Свойства, связанные с доступными действиями.Properties related to available actions.
Appearance Свойства, связанные с отображением сущности.Properties related to how an entity appears.
Behavior Свойства, относящиеся к взаимодействии сущности.Properties related to how an entity acts.
Data Свойства, связанные с управлением данными и источниками данных.Properties related to data and data source management.
Default Свойства, сгруппированные в категорию по умолчанию.Properties that are grouped in a default category.
Design Свойства, доступные только во время разработки.Properties that are available only at design time.
DragDrop Свойства, относящиеся к операциям перетаскивания.Properties related to drag-and-drop operations.
Focus Свойства, связанные с фокусом.Properties related to focus.
Format Свойства, связанные с форматированием.Properties related to formatting.
Key Свойства, связанные с клавиатурой.Properties related to the keyboard.
Layout Свойства, связанные с макетом.Properties related to layout.
Mouse Свойства, связанные с мышью.Properties related to the mouse.
WindowStyle Свойства, связанные с стилем окна форм верхнего уровня.Properties related to the window style of top-level forms.

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

Constructors

CategoryAttribute()

Инициализирует новый экземпляр класса CategoryAttribute с использованием имени категории "По умолчанию".Initializes a new instance of the CategoryAttribute class using the category name Default.

CategoryAttribute(String)

Выполняет инициализацию нового экземпляра класса CategoryAttribute, используя заданное имя категории.Initializes a new instance of the CategoryAttribute class using the specified category name.

Properties

Action

Возвращает атрибут CategoryAttribute, представляющий категорию "Действие".Gets a CategoryAttribute representing the Action category.

Appearance

Возвращает атрибут CategoryAttribute, представляющий категорию "Внешний вид".Gets a CategoryAttribute representing the Appearance category.

Asynchronous

Возвращает атрибут CategoryAttribute, представляющий категорию "Асинхронная".Gets a CategoryAttribute representing the Asynchronous category.

Behavior

Возвращает атрибут CategoryAttribute, представляющий категорию "Поведение".Gets a CategoryAttribute representing the Behavior category.

Category

Возвращает имя категории для свойства или события, к которым применяется этот атрибут.Gets the name of the category for the property or event that this attribute is applied to.

Data

Возвращает атрибут CategoryAttribute, представляющий категорию "Данные".Gets a CategoryAttribute representing the Data category.

Default

Возвращает атрибут CategoryAttribute, представляющий категорию "По умолчанию".Gets a CategoryAttribute representing the Default category.

Design

Возвращает атрибут CategoryAttribute, представляющий категорию "Конструктор".Gets a CategoryAttribute representing the Design category.

DragDrop

Возвращает атрибут CategoryAttribute, представляющий категорию "Перетаскивание".Gets a CategoryAttribute representing the DragDrop category.

Focus

Получает атрибут CategoryAttribute, представляющий категорию "Фокус".Gets a CategoryAttribute representing the Focus category.

Format

Возвращает атрибут CategoryAttribute, представляющий категорию "Формат".Gets a CategoryAttribute representing the Format category.

Key

Получает атрибут CategoryAttribute, представляющий категорию "Клавиша".Gets a CategoryAttribute representing the Key category.

Layout

Возвращает атрибут CategoryAttribute, представляющий категорию "Структура".Gets a CategoryAttribute representing the Layout category.

Mouse

Возвращает атрибут CategoryAttribute, представляющий категорию "Мышь".Gets a CategoryAttribute representing the Mouse category.

TypeId

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

(Inherited from Attribute)
WindowStyle

Возвращает атрибут CategoryAttribute, представляющий категорию "Стиль окна".Gets a CategoryAttribute representing the WindowStyle category.

Methods

Equals(Object)

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

GetHashCode()

Возвращает хэш-код для данного атрибута.Returns the hash code for this attribute.

GetLocalizedString(String)

Выполняет поиск локализованной версии имени заданной категории.Looks up the localized name of the specified category.

GetType()

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

(Inherited from Object)
IsDefaultAttribute()

Определяет, является ли этот атрибут используемым по умолчанию.Determines if this attribute is the default.

IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

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

(Inherited from Attribute)
MemberwiseClone()

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

(Inherited from Object)
ToString()

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

(Inherited from Object)

Explicit Interface Implementations

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

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

(Inherited from 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.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

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

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

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

(Inherited from Attribute)

Applies to

See also