Ajout de code à votre contrôle utilisateur

Article
08/21/2008

Mise à jour : novembre 2007

Dans cette leçon, vous apprendrez comment ajouter le code à votre contrôle utilisateur pour afficher le nom complet et exposer de nouvelles propriétés.

Comme les contrôles standard, les contrôles utilisateur possèdent des propriétés, des méthodes et des événements. En tant que développeur, vous écrirez le code permettant de gérer les événements de votre contrôle, et vous déterminerez les propriétés à exposer à l'utilisateur de votre contrôle.

Gestion des événements dans un contrôle utilisateur

Pour créer un contrôle utilisateur pratique, vous devrez écrire le code permettant de gérer les événements du contrôle. L'écriture d'une procédure de gestion des événements pour un contrôle utilisateur ne diffère pas de celle d'un formulaire ou d'un contrôle.

Dans cet exemple, vous écrirez une procédure événementielle qui mettra à jour l'étiquette FullName avec le contenu des zones FirstName, MiddleName et LastName que vous spécifiez, à l'aide du gestionnaire d'événements TextChanged.

Essayez !

Pour ajouter du code à un contrôle utilisateur

Ouvrez le projet NamesUserControl que vous avez créé dans la leçon précédente. Si vous ne l'aviez pas enregistré, vous devez d'abord revenir à la leçon précédente, Présentation du Concepteur de contrôles utilisateur, et réaliser les procédures qui s'y trouvent.
Dans l'Explorateur de solutions, sélectionnez NamesControl.vb, puis dans le menu Affichage, sélectionnez Code.

Dans l'éditeur de code, ajoutez le code suivant au gestionnaire d'événements FirstName_TextChanged.

Private Sub FirstName_TextChanged(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles FirstName.TextChanged, MiddleName.TextChanged, LastName.TextChanged
    ' Display the contents of the three text boxes in the label.
    FullName.Text = FirstName.Text & " " & MiddleName.Text & " " & LastName.Text
End Sub

Appuyez sur F5 pour exécuter le programme. Le Conteneur de test UserControl s'ouvre et affiche votre contrôle utilisateur.
Entrez le prénom, le deuxième prénom et le nom dans les trois zones de texte. Au fur et à mesure que vous tapez, votre nom s'affiche dans l'étiquette FullName.

Si vous observez le code que vous avez entré ci-dessus, vous remarquerez que la clause Handles de la déclaration gère l'événement TextChanged pour les trois contrôles TextBox. Quelle que soit la zone de texte que vous remplissez en premier, l'étiquette FullName est toujours mise à jour au fur et à mesure que vous tapez.

Exposition de propriétés dans un contrôle utilisateur

Les propriétés des contrôles standard permettent de définir et de récupérer des valeurs pour un contrôle au moment de la conception et au moment de l'exécution. Vous pouvez également mettre certaines propriétés de votre contrôle utilisateur à disposition afin de pouvoir les définir dans la fenêtre Propriétés au moment de la conception et les référencer dans votre code.

L'exposition de propriétés dans un contrôle utilisateur est très similaire à l'exposition des propriétés dans une classe ; la principale différence réside dans le fait que vous pouvez également exposer les propriétés des contrôles contenus dans votre contrôle utilisateur. Comme avec les classes, vous devez déclarer une propriété et ajouter du code aux procédures Get et Set. Si vous exposez une propriété d'un contrôle contenu, vous n'avez pas besoin de déclarer une variable privée pour stocker la valeur ; la propriété du contrôle la stocke pour vous.

Il n'existe actuellement aucun moyen de récupérer le texte entré dans les contrôles FirstName, MiddleName et LastName ou la valeur de l'étiquette FullName. Vous devez exposer leur valeur comme propriétés pour rendre le contrôle plus utile. Comme vous ne souhaitez pas que la valeur de l'étiquette FullName soit modifiée en dehors de votre propre code, vous pouvez l'exposer en tant que propriété en lecture seule.

Essayez !

Pour ajouter des propriétés

Dans l'éditeur de code, ajoutez le code suivant pour exposer les valeurs FirstName, MiddleName et LastName en tant que propriétés.

Property FirstNameText() As String
    Get
        Return FirstName.Text
    End Get
    Set(ByVal value As String)
        FirstName.Text = value
    End Set
End Property
Property MiddleNameText() As String
    Get
        Return MiddleName.Text
    End Get
    Set(ByVal value As String)
        MiddleName.Text = value
    End Set
End Property
Property LastNameText() As String
    Get
        Return LastName.Text
    End Get
    Set(ByVal value As String)
        LastName.Text = value
    End Set
End Property

Ajoutez le code suivant pour exposer la valeur de l'étiquette FullName en tant que propriété en lecture seule.
```
ReadOnly Property FullNameText() As String
    Get
        Return FullName.Text
    End Get
End Property
```
Appuyez sur F5 pour exécuter le programme.
Dans le Conteneur de test UserControl, faites défiler jusqu'au bas de la grille Propriétés et sélectionnez la propriété FirstNameText. Entrez votre nom, puis sélectionnez propriété FirstName (la zone de texte FirstName doit afficher votre nom et la propriété FullNameText doit être identique).

Essayez de modifier d'autres propriétés dans la grille Propriétés et dans le contrôle proprement dit pour observer la manière dont elles sont liées. C'est ce que pourra constater un utilisateur de votre contrôle au moment de la conception.
Dans le menu Fichier, choisissez Enregistrer tout pour enregistrer votre travail.

Étapes suivantes

Dans cette leçon, vous avez appris comment gérer des événements dans votre contrôle utilisateur et comment exposer certaines de ses propriétés. Vous pouvez approfondir vos connaissances sur les propriétés dans Présentation détaillée : ajout des propriétés avec les valeurs nommées, ou passer à la leçon suivante et apprendre comment utiliser le contrôle que vous avez créé.

Leçon suivante : Test de votre contrôle utilisateur.