Procédure pas à pas : héritage d'un contrôle Windows Forms à l'aide de Visual C#

Article
08/21/2008

Mise à jour : novembre 2007

Avec Visual C# 2005, vous pouvez créer des contrôles personnalisés puissants par le biais de l'héritage. L'héritage vous permet de créer des contrôles qui conservent toutes les fonctionnalités inhérentes des contrôles Windows Forms standard, mais qui intègrent également des fonctionnalités personnalisées. Dans cette procédure, vous allez créer un contrôle hérité simple, appelé ValueButton. Ce bouton héritera des fonctionnalités du contrôle Windows Forms standard Button, et exposera une propriété personnalisée appelée ButtonValue.

Remarque :
Selon vos paramètres actifs ou votre édition, les boîtes de dialogue et les commandes de menu que vous voyez peuvent différer de celles qui sont décrites dans l'aide. Pour modifier vos paramètres, choisissez Importation et exportation de paramètres dans le menu Outils. Pour plus d'informations, consultez Paramètres Visual Studio.

Création du projet

Lorsque vous créez un projet, vous spécifiez son nom pour définir l'espace de noms racine, le nom de l'assembly ainsi que celui du projet et vous avez la garantie que le composant par défaut sera placé dans l'espace de noms adéquat.

Pour créer la bibliothèque de contrôles ValueButtonLib et le contrôle ValueButton

Dans le menu Fichier, pointez sur Nouveau, puis cliquez sur Projet pour ouvrir la boîte de dialogue Nouveau projet.
Sélectionnez le modèle de projet Bibliothèque de contrôles Windows dans la liste des projets Visual C# et tapez ValueButtonLib dans la zone Nom.

Le nom de projet, ValueButtonLib, est également assigné à l'espace de noms racine par défaut. L'espace de noms racine sert à qualifier le nom des composants de l'assembly. Par exemple, si deux assemblys contiennent des composants nommés ValueButton, vous pouvez spécifier votre composant ValueButton à l'aide de ValueButtonLib.ValueButton. Pour plus d'informations, consultez Espaces de noms (Guide de programmation C#).
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur UserControl1.cs, puis cliquez sur Renommer dans le menu contextuel. Remplacez le nom de fichier par ValueButton.cs. Cliquez sur le bouton Oui à la question de savoir si vous souhaitez renommer toutes les références à l'élément de code "UserControl1".
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ValueButton.cs et sélectionnez Afficher le code.
Localisez la ligne d'instruction class, public partial class ValueButton, puis modifiez le type dont hérite ce contrôle en remplaçant UserControl par Button. Cela permet à votre contrôle hérité d'hériter toutes les fonctionnalités du contrôle Button.
Dans l'Explorateur de solutions, ouvrez le nœud ValueButton.cs pour afficher le fichier de code généré par le concepteur, ValueButton.Designer.cs. Ouvrez ce fichier dans l'éditeur de code.
Localisez la méthode InitializeComponent et supprimez la ligne qui assigne la propriété AutoScaleMode. Cette propriété n'existe pas dans le contrôle Button.

Dans le menu Fichier, choisissez Enregistrer tout pour enregistrer le projet.

Remarque :
Il n'existe plus de concepteur visuel. Étant donné que le contrôle Button définit sa propre apparence, vous ne pouvez pas la modifier dans le concepteur. Sa représentation graphique sera exactement la même que celle de la classe dont il hérite (à savoir, Button), sauf si elle est modifiée dans le code. Vous pouvez encore ajouter des composants qui n'ont pas d'éléments d'interface utilisateur à l'aire de conception.

Il n'existe plus de concepteur visuel. Étant donné que le contrôle Button définit sa propre apparence, vous ne pouvez pas la modifier dans le concepteur. Sa représentation graphique sera exactement la même que celle de la classe dont il hérite (à savoir, Button), sauf si elle est modifiée dans le code. Vous pouvez encore ajouter des composants qui n'ont pas d'éléments d'interface utilisateur à l'aire de conception.

Ajout d'une propriété à un contrôle hérité

Entre autres usages, les contrôles Windows Forms hérités peuvent être employés pour créer des contrôles identiques en apparence aux contrôles Windows Forms standard, mais exposant des propriétés personnalisées. Dans cette section, vous ajouterez à votre contrôle une propriété appelée ButtonValue.

Pour ajouter la propriété Value

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ValueButton.cs, puis cliquez sur Afficher le code dans le menu contextuel.
Recherchez l'instruction class. Immédiatement après {, tapez le code suivant :

[C#]
```
// Creates the private variable that will store the value of your 
// property.
private int varValue;
// Declares the property.
public int ButtonValue
{
   // Sets the method for retrieving the value of your property.
   get
   {
      return varValue;
   }
   // Sets the method for setting the value of your property.
   set
   {
      varValue = value;
   }
}
```
Ce code définit les méthodes par lesquelles la propriété ButtonValue est stockée et récupérée. L'instruction get définit comme valeur de retour la valeur stockée dans la variable privée varValue, et l'instruction set définit la valeur de la variable privée à l'aide du mot clé value.
Dans le menu Fichier, choisissez Enregistrer tout pour enregistrer le projet.

Test du contrôle

Les contrôles ne sont pas des projets autonomes ; ils doivent être hébergés dans un conteneur. Pour tester votre contrôle, vous devez spécifier un projet test dans lequel il s'exécutera. Vous devez également rendre votre contrôle accessible pour le projet test, en le générant (en le compilant). Dans cette section, vous allez générer un contrôle et le tester dans un Windows Form.

Pour générer le contrôle

Dans le menu Générer, cliquez sur Générer la solution.

Cette opération devrait s'effectuer sans engendrer d'erreur de compilation ni d'avertissement.

Pour créer un projet de test

Dans le menu Fichier, pointez sur Ajouter, puis cliquez sur Nouveau projet pour ouvrir la boîte de dialogue Ajouter un nouveau projet.
Sélectionnez le nœud Windows, sous le nœud Visual C#, et cliquez sur Application Windows.
Dans la zone Nom, tapez Test.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le nœud Références de votre projet test, puis sélectionnez Ajouter une référence dans le menu contextuel afin d'afficher la boîte de dialogue Ajouter une référence.
Cliquez sur l'onglet Projets. Votre projet ValueButtonLib est répertorié sous Nom du projet. Double-cliquez sur le projet pour ajouter la référence au projet de test.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur Test et sélectionnez Générer.

Pour ajouter votre contrôle au formulaire

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur Form1.cs et sélectionnez Concepteur de vues dans le menu contextuel.
Dans la boîte à outils, cliquez sur Composants ValueButtonLib. Double-cliquez sur ValueButton.

Un contrôle ValueButton apparaît dans le formulaire.
Cliquez avec le bouton droit sur ValueButton et sélectionnez Propriétés dans son menu contextuel.
Dans la fenêtre Propriétés, examinez les propriétés de ce contrôle. Notez qu'elles sont identiques à celles qui sont exposées par un bouton standard, à cela près qu'il existe une propriété supplémentaire, ButtonValue.
Affectez à la propriété ButtonValue la valeur 5.
Sous l'onglet Tous les Windows Forms de la Boîte à outils, double-cliquez sur Label pour ajouter un contrôle Label au formulaire.
Amenez l'étiquette au centre du formulaire.
Double-cliquez sur valueButton1.

L'éditeur de code s'ouvre à l'événement valueButton1_Click.

Insérez la ligne de code suivante.

[C#]

label1.Text = valueButton1.ButtonValue.ToString();

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur Test, puis sélectionnez Définir comme projet de démarrage dans le menu contextuel.
Dans le menu Déboguer, cliquez sur Démarrer le débogage.

Form1 apparaît.
Cliquez sur valueButton1.

Le chiffre « 6 » est affiché dans label1 pour indiquer que la propriété ButtonValue de votre contrôle hérité a été passée à label1 via la méthode valueButton1_Click. Votre contrôle ValueButton hérite ainsi de toutes les fonctionnalités du bouton Windows Forms standard, mais expose une propriété personnalisée supplémentaire.