CategoryAttribute, classe

CategoryAttribute indique la catégorie à associer à la propriété ou l'événement associés, lorsque des propriétés ou des événements sont affichés sous forme de liste dans un contrôle PropertyGrid défini en mode Categorized. Si CategoryAttribute n'a pas été appliqué à une propriété ou un événement, PropertyGrid l'associe à la catégorie Divers. Une nouvelle catégorie peut être créée pour n'importe quel nom en spécifiant le nom de la catégorie dans le constructeur de CategoryAttribute.

La propriété Category indique le nom de la catégorie que représente l'attribut. La propriété Category permet également la localisation transparente des noms de catégories.

Remarques à l'attention des héritiers :

Si vous utilisez d'autres noms que les noms de catégories prédéfinis et que vous souhaitez localiser vos noms de catégories, vous devez substituer la méthode GetLocalizedString. De plus, vous pouvez substituer la propriété Category pour fournir votre propre logique de localisation.

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

Pour plus d'informations, consultez Vue d'ensemble des attributs et Extension des métadonnées à l'aide des attributs.

L'exemple suivant crée la propriété MyImage. La propriété comporte deux attributs : DescriptionAttribute et CategoryAttribute.

[Description("The image associated with the control"),Category("Appearance")] 
 public Image MyImage {
    get {
       // Insert code here.
       return image1;
    }
    set {
       // Insert code here.
    }
 }

/** @attribute Description("The image associated with the control")
  * @attribute Category("Appearance")
 */
/** @property 
 */
public Image get_MyImage()
{
    // Insert code here.
    return image1;
} //get_MyImage

/** @property 
 */
public void set_MyImage(Image value)
{
    // Insert code here.
} //set_MyImage

L'exemple suivant obtient la catégorie de MyImage. Le code extrait d'abord PropertyDescriptorCollection avec toutes les propriétés de l'objet. Le code indexe ensuite dans PropertyDescriptorCollection pour obtenir MyImage. Il retourne ensuite les attributs pour cette propriété et les enregistre dans la variable attributes.

L'exemple imprime ensuite la catégorie en récupérant CategoryAttribute de AttributeCollection et en l'affichant sur 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 = 
    (CategoryAttribute)attributes[typeof(CategoryAttribute)];
 Console.WriteLine(myAttribute.Category);

// Gets the attributes for the property.
AttributeCollection attributes = TypeDescriptor.GetProperties(this)
    .get_Item("MyImage").get_Attributes();

// Prints the description by retrieving the CategoryAttribute.
// from the AttributeCollection.
CategoryAttribute myAttribute = (CategoryAttribute)(
    attributes.get_Item(CategoryAttribute.class.ToType()));
Console.WriteLine(myAttribute.get_Category());

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professionnel Édition x64, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

Le .NET Framework et le .NET Compact Framework ne prennent pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.

.NET Framework

Référence