Procédure pas à pas : création d'un contrôle composite à l'aide de Visual C#

Article
08/10/2011

Les contrôles composites offrent le moyen de créer et de réutiliser des interfaces graphiques personnalisées. Un contrôle composite est pour l'essentiel un composant doté d'une représentation visuelle. Il peut être constitué d'un ou de plusieurs contrôles Windows Forms, de composants ou de blocs de code, lesquels peuvent développer des fonctionnalités en validant des entrées de l'utilisateur, en modifiant des propriétés d'affichage ou en effectuant d'autres tâches imposées par le créateur du contrôle. Les contrôles composites peuvent être placés dans les Windows Forms de la même façon que les autres contrôles. Dans la première partie de cette procédure pas à pas, créez un simple contrôle composite appelé ctlClock. Dans la deuxième partie de la procédure, développez la fonctionnalité de ctlClock par l'intermédiaire de l'héritage.

Notes

Les boîtes de dialogue et les commandes de menu qui s'affichent peuvent être différentes de celles qui sont décrites dans l'aide, en fonction de vos paramètres actifs ou de l'édition utilisée. Pour modifier vos paramètres, choisissez Importation et exportation de paramètres dans le menu Outils. Pour plus d'informations, consultez Utilisation des paramètres.

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 pour avoir 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 ctlClockLib et le contrôle ctlClock

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

Le nom de projet, ctlClockLib, 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 ctlClock, vous pouvez spécifier votre composant ctlClock à l'aide de ctlClockLib.ctlClock.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur UserControl1.cs, puis cliquez sur Renommer. Remplacez le nom de fichier par ctlClock.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".

Notes

Par défaut, un contrôle composite hérite de la classe UserControl fournie par le système. La classe UserControl fournit les fonctionnalités requises par les contrôles composites et implémente des méthodes et des propriétés standard.
Dans le menu Fichier, cliquez sur Enregistrer tout pour enregistrer le projet.

Ajout de contrôles Windows et de composants au contrôle composite

L'interface visuelle est une partie essentielle de votre contrôle composite. Elle est implémentée par l'ajout d'un ou de plusieurs contrôles Windows à l'aire du concepteur. Dans la démonstration suivante, vous allez incorporer des contrôles Windows à votre contrôle composite et écrire du code pour implémenter ses fonctionnalités.

Pour ajouter un contrôle Label et un contrôle Timer à votre contrôle composite

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ctlClock.cs, puis cliquez sur Concepteur de vues.
Dans la Boîte à outils, développez le nœud Contrôles communs, puis double-cliquez sur Étiquette.

Un contrôle Label nommé label1 est ajouté à votre contrôle sur l'aire du concepteur.
Dans le concepteur, cliquez sur label1. Dans la fenêtre Propriétés, définissez les propriétés suivantes.

Propriété

Remplacez par

Nom

lblDisplay

Texte

(espace)

TextAlign

MiddleCenter

Font.Size

14
Dans la boîte à outils, développez le nœud Composants, puis double-cliquez sur Minuterie.

Une Timer étant un composant, elle n'a pas de représentation visuelle au moment de l'exécution. Par conséquent, ce composant n'apparaît pas avec les contrôles sur l'aire du concepteur, mais plutôt dans le Concepteur de composants (sous forme de barre d'état au bas de l'aire du concepteur).
Dans le Concepteur de composants, cliquez sur timer1, puis attribuez à la propriété Interval la valeur 1000 et à la propriété Enabled la valeur true.

La propriété Interval détermine la fréquence des graduations du composant Timer. À chaque graduation, le composant timer1 exécute le code de l'événement timer1_Tick. L'intervalle représente le nombre de millisecondes entre deux graduations.
Dans le Concepteur de composants, double-cliquez sur timer1 afin d'accéder à l'événement timer1_Tick de ctlClock.
Modifiez le code afin qu'il ressemble au code ci-après. N'oubliez pas de remplacer le modificateur d'accès private par protected.

[C#]
```
protected void timer1_Tick(object sender, System.EventArgs e)
{
    // Causes the label to display the current time.
    lblDisplay.Text = DateTime.Now.ToLongTimeString(); 
}
```
Ce code provoque l'affichage de l'heure actuelle dans lblDisplay. Comme l'intervalle de timer1 a été fixé à 1 000, cet événement se produit toutes les mille millisecondes, mettant ainsi à jour l'heure actuelle toutes les secondes.
Modifiez la méthode de telle sorte qu'elle puisse être substituée à l'aide du mot clé virtual. Pour plus d'informations, consultez la section « Héritage d'un contrôle utilisateur » ci-dessous.
```
protected virtual void timer1_Tick(object sender, System.EventArgs e)
```
Dans le menu Fichier, cliquez sur Enregistrer tout pour enregistrer le projet.

Propriété	Remplacez par
Nom	lblDisplay
Texte	(espace)
TextAlign	MiddleCenter
Font.Size	14

Ajout de propriétés au contrôle composite

Le contrôle horloge intègre à présent un contrôle Label et un composant Timer, avec chacun leur propre jeu de propriétés inhérentes. Bien que les propriétés individuelles de ces contrôles ne seront pas accessibles pour les autres utilisateurs de votre contrôle, vous pouvez créer et exposer des propriétés personnalisées en écrivant les blocs de code appropriés. Dans la procédure suivante, vous ajouterez à votre contrôle des propriétés permettant à l'utilisateur de changer la couleur d'arrière-plan et le texte.

Pour ajouter une propriété à votre contrôle composite

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ctlClock.cs, puis cliquez sur Afficher le code.

Vous voyez s'ouvrir l'éditeur de code de votre contrôle.
Recherchez l'instruction public partial class ctlClock. Sous l'accolade gauche ({), tapez le code suivant.

[C#]
```
private Color colFColor;
private Color colBColor;
```
Ces instructions créent les variables privées que vous utiliserez pour stocker les valeurs des propriétés que vous êtes sur le point de créer.

Tapez le code suivant sous les déclarations de variable de l'étape 2.

[C#]

// Declares the name and type of the property.
public Color ClockBackColor
{
    // Retrieves the value of the private variable colBColor.
    get
    {
        return colBColor;
    }
    // Stores the selected value in the private variable colBColor, and 
    // updates the background color of the label control lblDisplay.
    set
    {
        colBColor = value;
        lblDisplay.BackColor = colBColor;   
    }
}
// Provides a similar set of instructions for the foreground color.
public Color ClockForeColor
{
    get
    {
        return colFColor;
    }
    set
    {
        colFColor = value;
        lblDisplay.ForeColor = colFColor;
    }
}

Le code précédent crée deux propriétés personnalisées, ClockForeColor et ClockBackColor, disponibles pour les autres utilisateurs de ce contrôle. Les instructions get et set assurent le stockage et la récupération de la valeur de propriété ainsi que du code permettant d'implémenter les fonctionnalités appropriées à la propriété.

Dans le menu Fichier, cliquez sur Enregistrer tout pour enregistrer le projet.

Test du contrôle

Les contrôles ne sont pas des applications autonomes ; ils doivent être hébergés dans un conteneur. Testez le comportement à l'exécution de votre contrôle et essayez ses propriétés avec le conteneur de test UserControl. Pour plus d'informations, consultez Comment : tester le comportement d'un UserControl au moment de l'exécution.

Pour tester le contrôle

Appuyez sur F5 pour générer le projet et exécuter votre contrôle dans le conteneur de test UserControl.
Dans la grille des propriétés du conteneur de test, localisez la propriété ClockBackColor, puis sélectionnez la propriété pour afficher la palette de couleurs.
Choisissez une couleur en cliquant dessus.

La couleur d'arrière-plan du contrôle est remplacée par celle que vous avez sélectionnée.
Utilisez une séquence d'événements similaire pour vérifier que la propriété ClockForeColor fonctionne comme prévu.

Dans cette section et les sections précédentes, vous avez vu comment les composants et les contrôles Windows pouvaient être associés à du code et à un empaquetage afin d'offrir des fonctionnalités personnalisées sous la forme d'un contrôle composite. Vous avez appris à exposer des propriétés dans votre contrôle composite et à tester ce dernier, une fois terminé. Dans la section suivante, vous allez apprendre à construire un contrôle composite hérité en utilisant ctlClock comme base.

Héritage d'un contrôle composite

Dans les sections précédentes, vous avez appris à associer des contrôles Windows, des composants et du code dans des contrôles composites réutilisables. Votre contrôle composite peut à présent être utilisé comme base pour construire d'autres contrôles. Le processus par l'intermédiaire duquel une classe est dérivée d'une classe de base est appelé héritage. Dans cette section, vous allez créer un contrôle composite nommé ctlAlarmClock. Ce contrôle sera dérivé de son contrôle parent, à savoir ctlClock. Vous allez apprendre à étendre les fonctionnalités de ctlClock en substituant les méthodes parentes et en ajoutant de nouvelles méthodes et propriétés.

La première étape de la création d'un contrôle hérité consiste à le dériver de son parent. Cette action crée un nouveau contrôle qui présente toutes les propriétés, méthodes et caractéristiques graphiques du contrôle parent, mais qui peut également servir de base pour l'ajout de fonctionnalités nouvelles ou modifiées.

Pour créer le contrôle hérité

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ctlClockLib, pointez sur Ajouter, puis cliquez sur Contrôle utilisateur.

La boîte de dialogue Ajouter un nouvel élément s'ouvre.
Sélectionnez le modèle Contrôle utilisateur hérité.
Dans la zone Nom, tapez ctlAlarmClock.cs, puis cliquez sur Ajouter.

La boîte de dialogue Sélecteur d'héritage apparaît.
Sous Nom du composant, double-cliquez sur ctlClock.
Dans l'Explorateur de solutions, parcourez les projets en cours.

Notes

Un fichier appelé ctlAlarmClock.cs a été ajouté au projet actuel.

Ajout de propriétés d'alarme

Vous ajoutez des propriétés à un contrôle hérité de la même façon qu'à un contrôle composite. Vous allez maintenant utiliser la syntaxe de déclaration de propriété pour ajouter deux propriétés à votre contrôle : AlarmTime, qui stocke la valeur de date et d'heure à laquelle l'alarme se déclenche et AlarmSet, qui indique si l'alarme est activée ou non.

Pour ajouter des propriétés à votre contrôle composite

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ctlAlarmClock, puis cliquez sur Afficher le code.

Recherchez l'instruction public class. Notez que votre contrôle hérite de ctlClockLib.ctlClock. Sous l'instruction de l'accolade gauche ({), tapez le code suivant.

[C#]

private DateTime dteAlarmTime;
private bool blnAlarmSet;
// These properties will be declared as public to allow future 
// developers to access them.
public DateTime AlarmTime
{
    get
    {
        return dteAlarmTime;
    }
    set
    {
        dteAlarmTime = value;
    }
}
public bool AlarmSet
{
    get
    {
        return blnAlarmSet;
    }
    set
    {
        blnAlarmSet = value;
    }
}

Ajout d'éléments à l'interface graphique du contrôle

Votre contrôle hérité présente une interface visuelle identique à celle du contrôle hérité. Il possède les mêmes contrôles constituants que le contrôle parent, mais les propriétés de ces contrôles ne sont pas disponibles s'ils n'ont pas été exposés de manière spécifique. Vous pouvez ajouter des éléments à l'interface graphique d'un contrôle composite hérité comme vous le feriez pour n'importe quel contrôle composite. Pour modifier l'interface visuelle de votre alarme, vous allez ajouter un contrôle de type étiquette qui clignotera lors du déclenchement de l'alarme.

Pour ajouter le contrôle Label

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ctlAlarmClock, puis cliquez sur Concepteur de vues.

Le Concepteur de ctlAlarmClock s'ouvre dans la fenêtre principale.
Cliquez sur la partie affichage du contrôle et observez la fenêtre Propriétés.

Notes

Toutes les propriétés sont affichées, mais grisées. Cela signifie que ces propriétés sont propres à lblDisplay et qu'elles ne peuvent pas être modifiées dans la fenêtre Propriétés. Par défaut, les contrôles contenus dans un contrôle composite sont de type private et leurs propriétés ne sont accessibles par aucun moyen.

Notes

Si vous voulez permettre aux futurs utilisateurs de votre contrôle utilisateur d'accéder à ses contrôles internes, déclarez ceux-ci comme public ou protected. Cela vous permettra de définir et de modifier à l'aide du code approprié les propriétés des contrôles contenus dans le contrôle composite.
Ajoutez un contrôle Label à votre contrôle composite.
À l'aide de la souris, placez le contrôle Label immédiatement sous la zone d'affichage. Dans la fenêtre Propriétés, définissez les propriétés suivantes.

Propriété

Paramètre

Nom

lblAlarm

Texte

Alarme !

TextAlign

MiddleCenter

Visible

false

Propriété	Paramètre
Nom	lblAlarm
Texte	Alarme !
TextAlign	MiddleCenter
Visible	false

Ajout de la fonctionnalité d'alarme

Dans les procédures précédentes, vous avez ajouté des propriétés et un contrôle activant des fonctionnalités d'alarme dans votre contrôle composite. Dans cette procédure, vous allez ajouter du code afin de comparer l'heure actuelle à celle de l'alarme et, si elles sont identiques, de déclencher l'alarme. En substituant la méthode timer1_Tick de ctlClock et en lui ajoutant le code supplémentaire, vous étendez la fonction de ctlAlarmClock tout en conservant toutes les fonctionnalités inhérentes de ctlClock.

Pour substituer la méthode timer1_Tick de ctlClock

Dans l'éditeur de code, recherchez l'instruction private bool blnAlarmSet;. Immédiatement sous cette instruction, tapez l'instruction ci-dessous.

[C#]
```
private bool blnColorTicker;
```

Dans l'éditeur de code, recherchez l'accolade fermante (}) à la fin de la classe. Juste avant l'accolade, ajoutez le code ci-dessous.

[C#]

protected override void timer1_Tick(object sender, System.EventArgs e)
{
    // Calls the Timer1_Tick method of ctlClock.
    base.timer1_Tick(sender, e);
    // Checks to see if the alarm is set.
    if (AlarmSet == false)
        return;
    else
        // If the date, hour, and minute of the alarm time are the same as
        // the current time, flash an alarm. 
    {
        if (AlarmTime.Date == DateTime.Now.Date && AlarmTime.Hour == 
            DateTime.Now.Hour && AlarmTime.Minute == DateTime.Now.Minute)
        {
            // Sets lblAlarmVisible to true, and changes the background color based on
            // the value of blnColorTicker. The background color of the label 
            // will flash once per tick of the clock.
            lblAlarm.Visible = true;
            if (blnColorTicker == false) 
            {
                lblAlarm.BackColor = Color.Red;
                blnColorTicker = true;
            }
            else
            {
                lblAlarm.BackColor = Color.Blue;
                blnColorTicker = false;
            }
        }
        else
        {
            // Once the alarm has sounded for a minute, the label is made 
            // invisible again.
            lblAlarm.Visible = false;
        }
    }
}

L'ajout de ce code permet d'effectuer plusieurs tâches. L'instruction override ordonne au contrôle d'utiliser cette méthode à la place de celle qui a été héritée du contrôle de base. Lorsqu'elle est appelée, cette méthode appelle la méthode à laquelle elle se substitue en appelant l'instruction base.timer1_Tick, ce qui garantit que toutes les fonctionnalités incorporées au contrôle d'origine sont reproduites dans ce contrôle. Elle exécute ensuite du code supplémentaire afin d'intégrer la fonctionnalité d'alarme. Un contrôle de type étiquette clignotante apparaît lorsque l'alarme se produit.

Le contrôle de l'alarme est quasiment terminé. Il ne reste plus qu'à implémenter un moyen de le désactiver. Pour réaliser cette opération, vous ajouterez le code à la méthode lblAlarm_Click.

Pour implémenter la méthode shutoff

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ctlAlarmClock.cs, puis cliquez sur Concepteur de vues.

Le concepteur s'ouvre.
Ajoutez un bouton au contrôle. Définissez les propriétés du bouton comme ci-dessous.

Propriété

Valeur

Nom

btnAlarmOff

Texte

Désactiver l'alarme
Dans le concepteur, double-cliquez sur btnAlarmOff.

L'éditeur de code s'ouvre à la ligne private void btnAlarmOff_Click.

Propriété	Valeur
Nom	btnAlarmOff
Texte	Désactiver l'alarme

Modifiez cette méthode afin qu'elle ressemble au code ci-dessous.

[C#]

private void btnAlarmOff_Click(object sender, System.EventArgs e)
{
    // Turns off the alarm.
    AlarmSet = false;
    // Hides the flashing label.
    lblAlarm.Visible = false;
}

Dans le menu Fichier, cliquez sur Enregistrer tout pour enregistrer le projet.

Utilisation du contrôle hérité sur un formulaire

Vous pouvez tester votre contrôle hérité de la même façon que vous avez testé le contrôle de classe de base, ctlClock : appuyez sur F5 pour générer le projet et exécuter votre contrôle dans le conteneur de test UserControl. Pour plus d'informations, consultez Comment : tester le comportement d'un UserControl au moment de l'exécution.

Pour mettre votre contrôle en application, vous devrez l'héberger sur un formulaire. Comme dans le cas d'un contrôle composite standard, un contrôle composite hérité ne peut pas fonctionner de façon autonome et doit être hébergé dans un formulaire ou autre conteneur. Comme ctlAlarmClock présente une plus grande profondeur de fonctionnalités, un code supplémentaire est requis pour tester ce contrôle. Dans cette section, vous allez écrire un programme simple afin de tester les fonctionnalités de ctlAlarmClock. Vous allez écrire le code permettant de définir et d'afficher la propriété AlarmTime du contrôle ctlAlarmClock, puis tester ses fonctions inhérentes.

Pour générer et ajouter votre contrôle à un formulaire de test

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur ctlClockLib, puis cliquez sur Générer.
Ajoutez un nouveau projet d'application Windows à la solution et nommez-le Test.
Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le nœud References de votre projet test. Cliquez sur Ajouter une référence pour afficher la boîte de dialogue Ajouter une référence. Cliquez sur l'onglet Projets. Votre projet ctlClockLib 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, puis cliquez sur Générer.
Dans la Boîte à outils, développez le nœud Composants ctlClockLib.
Double-cliquez sur ctlAlarmClock pour ajouter une copie de ctlAlarmClock à votre formulaire.
Dans la Boîte à outils, localisez DateTimePicker et double-cliquez dessus afin d'ajouter un contrôle DateTimePicker à votre formulaire, puis ajoutez un contrôle Label en double-cliquant sur Label.
À l'aide de la souris, placez les contrôles dans le formulaire à un endroit adéquat.
Définissez les propriétés de ces contrôles de la manière suivante.

Contrôle

Propriété

Valeur

label1

Texte

(espace)

Nom

lblTest

dateTimePicker1

Nom

dtpTest

Format

Time
Dans le concepteur, double-cliquez sur dtpTest.

L'éditeur de code s'ouvre sur private void dtpTest_ValueChanged.

Contrôle	Propriété	Valeur
label1	Texte	(espace)
	Nom	lblTest
dateTimePicker1	Nom	dtpTest
	Format	Time

Modifiez le code afin qu'il ressemble au code ci-dessous.

[C#]

private void dtpTest_ValueChanged(object sender, System.EventArgs e)
{
    ctlAlarmClock1.AlarmTime = dtpTest.Value;
    ctlAlarmClock1.AlarmSet = true;
    lblTest.Text = "Alarm Time is " +
        ctlAlarmClock1.AlarmTime.ToShortTimeString();
}

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

Le programme de test démarre. Notez que l'heure actuelle est mise à jour dans le contrôle ctlAlarmClock et que l'heure de démarrage est affichée dans le contrôle DateTimePicker.
Cliquez sur le contrôle DateTimePicker dans lequel sont affichées les minutes de l'heure.
À l'aide du clavier, définissez pour les minutes une valeur supérieure d'une minute à l'heure actuelle affichée dans ctlAlarmClock.

L'heure de définition de l'alarme apparaît dans lblTest. Attendez que l'heure affichée atteigne l'heure définie pour l'alarme. Lorsque l'heure affichée atteint l'heure à laquelle l'alarme est définie, l'étiquette lblAlarm clignote.
Désactivez l'alarme en cliquant sur btnAlarmOff. Vous pouvez maintenant réinitialiser l'alarme.

Cette procédure pas à pas a illustré plusieurs concepts clés. Vous avez appris à créer un contrôle composite en associant des contrôles et des composants dans un conteneur de contrôle composite. Vous avez appris à ajouter des propriétés à votre contrôle et à écrire du code afin d'implémenter des fonctionnalités personnalisées. Dans la dernière section, vous avez appris à étendre les fonctionnalités d'un contrôle composite donné par l'intermédiaire de l'héritage, ainsi qu'à modifier les fonctionnalités des méthodes hôtes en substituant ces méthodes.

Voir aussi

Procédure pas à pas : création d'un contrôle composite à l'aide de Visual C#

Création du projet

Pour créer la bibliothèque de contrôles ctlClockLib et le contrôle ctlClock

Ajout de contrôles Windows et de composants au contrôle composite

Pour ajouter un contrôle Label et un contrôle Timer à votre contrôle composite

Ajout de propriétés au contrôle composite

Pour ajouter une propriété à votre contrôle composite

Test du contrôle

Pour tester le contrôle

Héritage d'un contrôle composite

Pour créer le contrôle hérité

Ajout de propriétés d'alarme

Pour ajouter des propriétés à votre contrôle composite

Ajout d'éléments à l'interface graphique du contrôle

Pour ajouter le contrôle Label

Ajout de la fonctionnalité d'alarme

Pour substituer la méthode timer1_Tick de ctlClock

Pour implémenter la méthode shutoff

Utilisation du contrôle hérité sur un formulaire

Pour générer et ajouter votre contrôle à un formulaire de test

Voir aussi

Tâches

Concepts

Autres ressources

Ressources supplémentaires