HelpComplete-Ereignis

[Der Microsoft-Agent ist ab Windows 7 veraltet und in nachfolgenden Versionen von Windows möglicherweise nicht mehr verfügbar.]

Beschreibung

Gibt an, dass der kontextbezogene Hilfemodus beendet wurde.

Syntax

Sub-Agent.**(ByVal * CharacterID!), ByVal-Name**, * ByVal-Ursache)) * *

Teil BESCHREIBUNG
CharacterID Gibt die ID des geklickten Zeichens 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, wodurch der Hilfemodus abgeschlossen wurde. 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 Sprachbefehle schließen ausgewählt.
5 Der Benutzer hat den Befehl Zeichenname anzeigen ausgewählt.
6 Der Benutzer hat den Befehl CharacterName ausblenden ausgewählt.
7 Der Benutzer hat das Zeichen ausgewählt (geklickt).

Bemerkungen

In der Regel wird der Hilfemodus abgeschlossen, wenn der Benutzer auf das Zeichen klickt oder es zieht oder einen Befehl aus dem Popupmenü des Zeichens auswählt. Wenn Sie auf ein anderes Zeichen oder an anderer Stelle auf dem Bildschirm klicken, wird der Hilfemodus nicht abgebrochen. Der Client, der den Hilfemodus für das Zeichen festlegt, kann den Hilfemodus abbrechen, indem HelpModeOn auf False festgelegt wird. (Dadurch wird das HelpComplete-Ereignis nicht ausgelöst.)

Wenn der Benutzer im Hilfemodus im Popupmenü des Zeichens einen Befehl auswählt, entfernt der Server das Menü, ruft die Hilfe mit der angegebenen HelpContextIDdes Befehls auf und sendet dieses Ereignis. Kontextabhängig (auch bekannt als What es This?) Das Hilfefenster wird an der Zeigerposition angezeigt. Wenn der Benutzer den Befehl per Spracheingabe auswählt, wird das Hilfefenster über dem Zeichen angezeigt. Wenn sich das Zeichen außerhalb des Bildschirms befindet, wird das Fenster auf dem Bildschirm angezeigt, der der aktuellen Position des Zeichens 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 das Zeichen im Hilfemodus platziert.

Weitere Informationen

HelpModeOn-Eigenschaft, HelpContextID-Eigenschaft