Procédure pas à pas : gestion des événements (Visual Basic)

Article
06/08/2015

Cette rubrique est la deuxième des deux rubriques consacrées à la manipulation des événements. La première rubrique, Procédure pas à pas : déclaration et déclenchement des événements, explique comment déclarer et déclencher des événements. La présente section utilise le formulaire et la classe de la première procédure pas à pas pour montrer comment gérer les événements lorsqu'ils se produisent.

L'exemple de classe Widget utilise des instructions de gestion des événements traditionnelles. Visual Basic fournit d'autres techniques pour l'utilisation des événements. En guise d'exercice, vous pouvez modifier cet exemple de façon à utiliser des instructions AddHandler et Handles.

Tapez le code suivant dans Form1 :
```
Private WithEvents mWidget As Widget
Private mblnCancel As Boolean
```
Le mot clé WithEvents spécifie que la variable mWidget est utilisée pour gérer les événements d'un objet. Pour spécifier le type d'objet, vous devez fournir le nom de la classe à partir de laquelle cet objet sera créé.

La variable mWidget est déclarée dans Form1 parce que les variables WithEvents doivent être de niveau classe. Cela est vrai quel que soit le type de classe dans lequel vous les placez.

La variable mblnCancel est employée pour annuler la méthode LongTask.

Écriture de code pour la gestion d'un événement

Dès que vous déclarez une variable à l'aide de WithEvents, le nom de la variable apparaît dans la zone de liste déroulante de gauche dans l'éditeur de code de la classe. Quand vous sélectionnez mWidget, les événements de la classe Widget apparaissent dans la zone de liste déroulante de droite. Si vous sélectionnez un événement, la procédure événementielle correspondante s'affiche, avec le préfixe mWidget et un caractère de soulignement. Toutes les procédures événementielles associées à une variable WithEvents reçoivent comme préfixe le nom de la variable.

Pour gérer un événement

Sélectionnez mWidget dans la zone de liste déroulante de gauche dans l'éditeur de code.
Sélectionnez l'événement PercentDone dans la zone de liste déroulante de droite. L'éditeur de code ouvre la procédure événementielle mWidget_PercentDone.

Notes

L'éditeur de code est utile, mais pas obligatoire, pour l'insertion de nouveaux gestionnaires d'événements.Dans cette procédure pas à pas, il est plus rapide de copier simplement les gestionnaires d'événements directement dans votre code.
Ajoutez le code suivant au gestionnaire d'événements mWidget_PercentDone :
```
Private Sub mWidget_PercentDone( 
    ByVal Percent As Single, 
    ByRef Cancel As Boolean 
) Handles mWidget.PercentDone
    lblPercentDone.Text = CInt(100 * Percent) & "%"
    My.Application.DoEvents()
    If mblnCancel Then Cancel = True 
End Sub
```
Chaque fois que l'événement PercentDone est déclenché, la procédure événementielle affiche le pourcentage réalisé dans un contrôle Label. La méthode DoEvents permet que l'étiquette soit repeinte et donne également à l'utilisateur la possibilité de cliquer sur le bouton Annuler.

Ajoutez le code suivant pour le gestionnaire d'événements Button2_Click :

Private Sub Button2_Click( 
    ByVal sender As Object, 
    ByVal e As System.EventArgs 
) Handles Button2.Click
    mblnCancel = True 
End Sub

Si l'utilisateur clique sur le bouton Annuler pendant l'exécution de la méthode LongTask, l'événement Button2_Click est exécuté dès que l'instruction DoEvents permet le traitement de l'événement. La variable de classe mblnCancel prend la valeur True ; l'événement mWidget_PercentDone la teste ensuite et assigne la valeur True à l'argument ByRef Cancel.

Association d'une variable WithEvents à un objet

Form1 est désormais prêt à gérer les événements d'un objet Widget. Il ne reste qu'à trouver un objet Widget.

Quand vous déclarez une variable WithEvents au moment du design, aucun objet n'est associé à celle-ci. Une variable WithEvents n'est qu'une variable objet parmi les autres. Vous devez créer un objet et lui assigner une référence avec la variable WithEvents.

Pour créer un objet et lui assigner une référence

Sélectionnez (Form1 Events) dans la zone de liste déroulante de gauche dans l'éditeur de code.
Sélectionnez l'événement Load dans la zone de liste déroulante de droite. L'éditeur de code ouvre la procédure événementielle Form1_Load.

Ajoutez le code suivant pour la procédure événementielle Form1_Load afin de créer le Widget:

Private Sub Form1_Load( 
    ByVal sender As System.Object, 
    ByVal e As System.EventArgs 
) Handles MyBase.Load
    mWidget = New Widget
End Sub

Lorsque ce code s'exécute, Visual Basic crée un objet Widget et associe ses événements aux procédures événementielles de mWidget. À partir de ce moment, chaque fois que l'objet Widget déclenche son événement PercentDone, la procédure événementielle mWidget_PercentDone est exécutée.

Pour appeler la méthode LongTask

Ajoutez le code suivant au gestionnaire d'événements Button1_Click :

Private Sub Button1_Click( 
    ByVal sender As Object, 
    ByVal e As System.EventArgs 
) Handles Button1.Click
    mblnCancel = False
    lblPercentDone.Text = "0%"
    lblPercentDone.Refresh()
    mWidget.LongTask(12.2, 0.33)
    If Not mblnCancel Then lblPercentDone.Text = CStr(100) & "%" 
End Sub

Avant que la méthode LongTask ne soit appelée, l'étiquette qui affiche le pourcentage de réalisation doit être initialisée, et l'indicateur de classe Boolean utilisé pour l'annulation de la méthode doit avoir la valeur False.

La méthode LongTask est appelée, la durée de la tâche étant de 12,2 secondes. L'événement PercentDone est déclenché tous les tiers de seconde. À chaque déclenchement de l'événement, la procédure événementielle mWidget_PercentDone est exécutée.

Une fois la méthode LongTask terminée, la variable mblnCancel est testée pour déterminer si LongTask s'est terminée normalement ou si elle s'est arrêtée parce que mblnCancel avait la valeur True. Le pourcentage de réalisation de la tâche est mis à jour seulement dans le premier cas.

Pour exécuter le programme

Appuyez sur F5 pour passer le projet en mode exécution.
Cliquez sur le bouton Start Task. Chaque fois que l'événement PercentDone est déclenché, l'étiquette est mise à jour de façon à afficher le pourcentage de tâche réalisé.
Cliquez sur le bouton Cancel pour arrêter la tâche. Notez que l'apparence du bouton Annuler ne change pas immédiatement lorsque vous cliquez dessus. L'événement Click ne peut pas se produire tant que l'instruction My.Application.DoEvents n'autorise pas le traitement de l'événement.

Notes

La méthode My.Application.DoEvents ne traite pas les événements exactement de la même manière que le formulaire.Par exemple, dans cette procédure pas à pas, vous devez cliquer deux fois sur le bouton Annuler.Pour permettre au formulaire de gérer les événements directement, vous pouvez utiliser le multithreading.Pour plus d'informations, consultez Threads (C# et Visual Basic).

Il peut se révéler intéressant d'exécuter le programme en appuyant sur F11 pour exécuter le code pas à pas, une ligne à la fois. Vous verrez alors clairement comment l'exécution passe à la méthode LongTask, puis repasse brièvement dans Form1 chaque fois que l'événement PercentDone est déclenché.

Que se passerait-il si, une fois l'exécution de retour dans le code de Form1, la méthode LongTask était de nouveau appelée ? Au pire, il pourrait y avoir un dépassement de capacité de la pile si la méthode LongTask était appelée à chaque déclenchement de l'événement.

Vous pouvez faire en sorte que la variable mWidget gère des événements d'un autre objet Widget en assignant à mWidget une référence au nouvel objet Widget. En réalité, vous pouvez faire en sorte que le code de la procédure Button1_Click effectue cette opération chaque fois que vous cliquez sur ce bouton.

Ajoutez la ligne de code suivante à la procédure Button1_Click, juste avant la ligne mWidget.LongTask(12.2, 0.33) :
```
mWidget = New Widget
' Create a new Widget object.
```

Le code ci-dessus crée un nouvel objet Widget chaque fois que l'on clique sur le bouton. Dès que la méthode LongTask s'achève, la référence à l'objet Widget est libérée et l'objet Widget est détruit.

Une variable WithEvents ne peut contenir qu'une seule référence d'objet à la fois. Dès lors, si vous assignez un autre objet Widget à mWidget, les événements de l'ancien objet Widget ne sont plus gérés. Si mWidget est la seule variable objet qui contient une référence à l'ancien objet Widget, ce dernier est détruit. Pour pouvoir gérer les événements de plusieurs objets Widget, utilisez l'instruction AddHandler qui permet de traiter séparément les événements de chaque objet.

Notes

Vous pouvez déclarer autant de variables WithEvents qu'il en faut, mais les tableaux de variables WithEvents ne sont pas pris en charge.

Voir aussi

Tâches

Procédure pas à pas : déclaration et déclenchement des événements (Visual Basic)

Autres ressources

Événements (Visual Basic)

Partager via