HelpComplete-Ereignis
[Der Microsoft Agent ist seit Windows 7 veraltet und kann in späteren Versionen von Windows nicht mehr verfügbar sein.]
-
Beschreibung
-
Gibt an, dass der kontextabhängige Hilfemodus beendet wurde.
-
Syntax
-
Sub agent.(ByVal CharacterID**, ByVal** Name**, ByVal** Cause**)**
Teil Beschreibung CharacterID Gibt die ID des angeklickten Charakters als Zeichenfolge zurück. Name Gibt einen Zeichenfolgenwert zurück, der den Namen (ID) des Befehls identifiziert. Ursache Gibt einen Wert zurück, der angibt, was die Beendigung des Hilfemodus verursacht hat. 1 Der Benutzer hat einen von Ihrer Anwendung bereitgestellten Befehl ausgewählt.
2 Der Benutzer hat das Commands-Objekt eines anderen Clients ausgewählt.
3 Der Benutzer hat den Befehl „Open Voice Commands“ ausgewählt.
4 Der Benutzer hat den Befehl „Close Voice Commands“ ausgewählt.
5 Der Benutzer hat den CharacterName-Befehl „Show“ ausgewählt.
6 Der Benutzer hat den CharacterName-Befehl „Hide“ ausgewählt.
7 Der Benutzer hat den Charakter ausgewählt (angeklickt).
Hinweise
Normalerweise wird der Hilfemodus abgeschlossen, wenn der Benutzer auf den Charakter klickt oder ihn zieht oder einen Befehl aus dem Popupmenü des Charakters auswählt. Durch Klicken auf einen anderen Charakter oder auf eine andere Stelle auf dem Bildschirm wird der Hilfemodus nicht abgebrochen. Der Client, der den Hilfemodus für den Charakter festlegt, kann den Hilfemodus abbrechen, indem HelpModeOn auf False festgelegt wird. (Dadurch wird das HelpComplete-Ereignis nicht ausgelöst.)
Wenn der Benutzer einen Befehl aus dem Popupmenü des Charakters im Hilfemodus auswählt, entfernt der Server das Menü, ruft die Hilfe mit der angegebenen HelpContextID des Befehls auf und sendet dieses Ereignis. Das kontextsensitive Hilfefenster (auch „What's This?“ genannt) wird an der Zeigerposition angezeigt. Wenn der Benutzer den Befehl per Spracheingabe auswählt, wird das Hilfefenster über dem Charakter angezeigt. Wenn sich der Charakter außerhalb des Bildschirms befindet, wird das Fenster auf dem Bildschirm angezeigt, das der aktuellen Position des Charakters am nächsten ist.
Wenn der Server „Name“ als leere Zeichenfolge ("") zurückgibt, gibt er an, dass der Benutzer einen vom Server bereitgestellten Befehl ausgewählt hat.
Dieses Ereignis wird nur an die Clientanwendung gesendet, die den Charakter im Hilfemodus platziert.