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

Cette procédure pas à pas explique comment déclarer et déclencher des événements pour une classe nommée Widget. Après avoir réalisé les diverses étapes de la procédure, il peut s'avérer utile de lire la rubrique connexe, Procédure pas à pas : gestion des événements (Visual Basic), qui montre comment utiliser des événements à partir d'objets Widget afin de fournir des informations d'état dans une application.

Classe Widget

Envisageons pour l'instant une classe du nom de Widget. Votre classe Widget comprend une méthode qui peut prendre du temps à s'exécuter, et vous voulez que votre application puisse afficher une sorte d'indicateur d'achèvement de cette tâche.

Il est clair que vous pourriez faire en sorte que l'objet Widget affiche une boîte de dialogue indiquant le pourcentage de réalisation de l'opération, mais cette boîte de dialogue apparaîtrait alors systématiquement dans tous les projets dans lesquels la classe Widget a été utilisée. Un principe utile à suivre en matière de design d'objets consiste à laisser l'application qui utilise un objet le soin de gérer l'interface utilisateur, à moins que l'objectif général de l'objet soit de gérer un formulaire ou une boîte de dialogue.

Widget a pour objectif d'effectuer d'autres tâches, c'est pourquoi il est préférable d'ajouter un événement PercentDone et de laisser à la procédure qui appelle les méthodes de la classe Widget le soin de gérer cet événement et d'afficher des mises à jour d'état. L'événement PercentDone peut également fournir un mécanisme d'annulation de la tâche.

Pour créer l'exemple de code de cette rubrique

1. Ouvrez un nouveau projet Application Windows Visual Basic, puis créez un formulaire nommé Form1.

2. Ajoutez deux boutons et une étiquette à Form1.

3. Nommez les objets de la façon indiquée dans le tableau suivant.

   Objet	Propriété	Paramètre
   Button1	Text	Start Task
   Button2	Text	Cancel
   Label	(Name), Text	lblPercentDone, 0

4. Dans le menu Projet, sélectionnez Ajouter une classe pour ajouter une classe nommée Widget.vb au projet.

Pour déclarer un événement pour la classe Widget

• Utilisez le mot clé Event pour déclarer un événement dans la classe Widget. Notez qu'un événement peut comporter des arguments ByVal et ByRef, comme l'illustre l'événement PercentDone de Widget :

  Public Event PercentDone(ByVal Percent As Single, 
                           ByRef Cancel As Boolean)
  

Lorsque l'objet appelant reçoit un événement PercentDone, l'argument Percent contient le pourcentage de tâche réalisé. L'argument Cancel peut avoir la valeur True pour annuler la méthode ayant déclenché l'événement.

L'événement PercentDone est déclenché par la méthode LongTask de la classe Widget. LongTask accepte deux arguments : la durée pendant laquelle la méthode prétend être active et l'intervalle de temps minimal requis avant que la méthode LongTask ne soit suspendue pour déclencher l'événement PercentDone.

Pour déclencher l'événement PercentDone

1. Pour simplifier l'accès à la propriété Timer utilisée par cette classe, ajoutez une instruction Imports en haut de la section des déclarations de votre module de classe, au-dessus de l'instruction Class Widget.

   Imports Microsoft.VisualBasic.DateAndTime
   

2. Ajoutez le code suivant à la classe Widget :

   Public Sub LongTask(ByVal Duration As Single, 
                       ByVal MinimumInterval As Single)
       Dim Threshold As Single 
       Dim Start As Single 
       Dim blnCancel As Boolean 
   
       ' The Timer property of the DateAndTime object returns the seconds 
       ' and milliseconds that have passed since midnight.
       Start = CSng(Timer)
       Threshold = MinimumInterval
   
       Do While CSng(Timer) < (Start + Duration)
           ' In a real application, some unit of work would 
           ' be done here each time through the loop. 
           If CSng(Timer) > (Start + Threshold) Then 
               RaiseEvent PercentDone( 
               Threshold / Duration, blnCancel)
               ' Check to see if the operation was canceled. 
               If blnCancel Then Exit Sub
               Threshold = Threshold + MinimumInterval
           End If 
       Loop 
   End Sub
   

Lorsque votre application appelle la méthode LongTask, la classe Widget déclenche l'événement PercentDone chaque MinimumInterval seconde. Lorsque l'événement est retourné, la méthode LongTask contrôle si l'argument Cancel avait la valeur True.

Quelques mises en garde s'imposent toutefois à ce stade. Pour des raisons de simplicité, la procédure LongTask suppose que vous connaissez au préalable le temps que va durer la tâche, ce qui n'est pratiquement jamais le cas. Il peut être difficile de diviser les tâches en segments de même longueur et, la plupart du temps, l'information qui compte le plus aux yeux des utilisateurs est simplement le temps qui s'écoule avant qu'ils ne voient s'afficher un message indiquant que quelque chose se produit.

Il se peut que vous ayez remarqué une autre faille dans cet exemple. La propriété Timer retourne le nombre de secondes écoulées depuis minuit, c'est pourquoi l'application se bloque si elle est démarrée juste avant minuit. Une approche plus prudente pour la mesure du temps consisterait à prendre en compte des conditions de limite telles que celle-ci ou éviter purement et simplement qu'elles n'utilisent des propriétés telles que Now.

Maintenant que la classe Widget peut déclencher des événements, vous pouvez passer à la procédure pas à pas suivante. Procédure pas à pas : gestion des événements (Visual Basic) montre comment utiliser WithEvents pour associer un gestionnaire d'événements à l'événement PercentDone.

Voir aussi

Tâches

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

Référence

Timer

Now

Autres ressources

Événements (Visual Basic)