Événement HelpComplete
[Microsoft Agent est déconseillé à partir de Windows 7 et peut être indisponible dans les versions ultérieures de Windows.]
-
Description
-
Indique que le mode d'aide contextuelle a été quitté.
-
Syntaxe
-
Sub agent.(ByVal CharacterID**, ByVal** Name**, ByVal** Cause**)**
Élément Description CharacterID Renvoie l'ID du personnage cliqué sous forme de chaîne de caractères. Nom Renvoie une valeur sous forme de chaîne identifiant le nom (ID) de la commande. Cause Renvoie une valeur indiquant la cause de la fin du mode d'aide. 1 L'utilisateur a sélectionné une commande fournie par votre application.
2 L'utilisateur a sélectionné l'objet Commandes d'un autre client.
3 L'utilisateur a sélectionné la commande Ouvrir les commandes vocales.
4 L'utilisateur a sélectionné la commande Fermer les commandes vocales.
5 L'utilisateur a sélectionné la commande Afficher le nom du personnage.
6 L'utilisateur a sélectionné la commande Masquer le nom du personnage.
7 L'utilisateur a sélectionné (cliqué) le personnage.
Notes
En règle générale, le mode Aide se termine lorsque l'utilisateur clique ou fait glisser le personnage ou sélectionne une commande dans la fenêtre contextuelle du personnage. Le fait de cliquer sur un autre personnage ou ailleurs à l'écran n'annule pas le mode Aide. Le client qui a défini le mode Aide pour le personnage peut l'annuler en attribuant la valeur False à HelpModeOn. (Cela ne déclenche pas l'événement HelpComplete).
Lorsque l'utilisateur sélectionne une commande dans le menu contextuel du personnage en mode Aide, le serveur supprime le menu, appelle l'aide avec le HelpContextID spécifié pour la commande et envoie cet événement. La fenêtre d'aide contextuelle (également appelée "Qu'est-ce que c'est ?") s'affiche à l'emplacement du pointeur. Si l'utilisateur sélectionne la commande par saisie vocale, la fenêtre d'aide s'affiche au-dessus du personnage. Si le personnage n'est pas à l'écran, la fenêtre est affichée à l'écran le plus près de la position actuelle du personnage.
Si le serveur renvoie Name sous la forme d'une chaîne vide (""), cela signifie que l'utilisateur a sélectionné une commande fournie par le serveur.
Cet événement n'est envoyé qu'à l'application cliente qui place le personnage en mode Aide.