CategoryAttribute Classe

Définition

Espace de noms:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Source:

CategoryAttribute.cs

Spécifie le nom de la catégorie dans laquelle grouper la propriété ou l'événement lorsqu'ils s'affichent dans un contrôle PropertyGrid défini en mode Par catégorie.

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

Héritage

Object

Attribute

CategoryAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant crée la MyImage propriété . La propriété a deux attributs : un DescriptionAttribute et un 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

L’exemple suivant obtient la catégorie pour MyImage. Tout d’abord, le code obtient un PropertyDescriptorCollection avec toutes les propriétés de l’objet. Ensuite, le code s’indexe dans pour PropertyDescriptorCollection obtenir MyImage. Ensuite, il retourne les attributs de cette propriété et les enregistre dans la variable attributes.

L’exemple imprime ensuite la catégorie en récupérant à partir de et AttributeCollectionen l’écrivant CategoryAttribute dans l’écran de la console.

// 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)

Remarques

Un CategoryAttribute indique la catégorie à laquelle associer la propriété ou l’événement associé, lors de la liste des propriétés ou des événements dans un PropertyGrid contrôle défini sur Categorized mode. Si un CategoryAttribute n’a pas été appliqué à une propriété ou à un événement, l’associe PropertyGrid à la catégorie Misc . Vous pouvez créer une nouvelle catégorie pour n’importe quel nom en spécifiant le nom de la catégorie dans le constructeur pour .CategoryAttribute

La Category propriété indique le nom de la catégorie que l’attribut représente. La Category propriété fournit également une localisation transparente des noms de catégorie.

Notes pour les héritiers

Si vous utilisez des noms de catégorie autres que les noms prédéfinis et que vous souhaitez localiser vos noms de catégorie, vous devez remplacer la GetLocalizedString(String) méthode.

La CategoryAttribute classe définit les catégories courantes suivantes :

Category	Description
Action	Propriétés liées aux actions disponibles.
Appearance	Propriétés liées à l’apparence d’une entité.
Behavior	Propriétés liées à la façon dont une entité agit.
Data	Propriétés liées à la gestion des données et des sources de données.
Default	Propriétés regroupées dans une catégorie par défaut.
Design	Propriétés disponibles uniquement au moment de la conception.
DragDrop	Propriétés liées aux opérations de glisser-déplacer.
Focus	Propriétés liées au focus.
Format	Propriétés liées à la mise en forme.
Key	Propriétés liées au clavier.
Layout	Propriétés liées à la disposition.
Mouse	Propriétés liées à la souris.
WindowStyle	Propriétés liées au style de fenêtre des formulaires de niveau supérieur.

Pour plus d’informations, consultez Attributs.

Constructeurs

CategoryAttribute()	Initialise une nouvelle instance de la classe CategoryAttribute à l'aide du nom de catégorie Par défaut.
CategoryAttribute(String)	Initialise une nouvelle instance de la classe CategoryAttribute à l'aide du nom de catégorie spécifié.

Propriétés

Action	Obtient un CategoryAttribute représentant la catégorie Action.
Appearance	Obtient un CategoryAttribute représentant la catégorie Apparence.
Asynchronous	Obtient un CategoryAttribute représentant la catégorie Asynchrone.
Behavior	Obtient un CategoryAttribute représentant la catégorie Comportement.
Category	Obtient le nom de la catégorie pour la propriété ou l'événement auquel cet attribut est appliqué.
Data	Obtient un CategoryAttribute représentant la catégorie Données.
Default	Obtient un CategoryAttribute représentant la catégorie Par défaut.
Design	Obtient un CategoryAttribute représentant la catégorie Design.
DragDrop	Obtient un CategoryAttribute représentant la catégorie Glisser-déplacer.
Focus	Obtient un CategoryAttribute représentant la catégorie Focus.
Format	Obtient un CategoryAttribute représentant la catégorie Format.
Key	Obtient un CategoryAttribute représentant la catégorie Clavier.
Layout	Obtient un CategoryAttribute représentant la catégorie Disposition.
Mouse	Obtient un CategoryAttribute représentant la catégorie Souris.
TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)
WindowStyle	Obtient un CategoryAttribute représentant la catégorie Style de fenêtre.

Méthodes

Equals(Object)	Retourne une valeur indiquant si la valeur de l'objet donné est égale au CategoryAttribute en cours.
GetHashCode()	Retourne le code de hachage pour cet attribut.
GetLocalizedString(String)	Recherche le nom localisé de la catégorie spécifiée.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	Détermine si cet attribut est l'attribut par défaut.
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• Attribute
• PropertyDescriptor
• EventDescriptor