HelpComplete 事件

[自 Windows 7 起弃用 Microsoft Agent,在后续版本的 Windows 中可能不可用。]

描述

表示已退出上下文相关的帮助模式。

语法

代理。(ByVal CharacterID**、ByVal** 名称**、ByVal** 原因**)**

组成部分 说明
CharacterID 以字符串形式返回单击字符的 ID。
Name 返回标识命令名称 (ID) 的字符串值。
原因 返回一个值,该值表明导致帮助模式完成的原因。 1 用户选择了应用程序提供的命令。
2 用户选择了另一个客户端的 Commands 对象。
3 用户选择了“打开语音命令”命令。
4 用户选择了“关闭语音命令”命令。
5 用户选择了“显示 CharacterName”命令。
6 用户选择了“隐藏 CharacterName”命令。
7 用户选择了字符(已单击)。

注解

通常,当用户单击或拖动字符,或从字符的弹出菜单中选择命令时,帮助模式将会结束。 单击其他字符或屏幕上的其他位置不会取消帮助模式。 为字符设置帮助模式的客户端可以通过将 HelpModeOn 设置为 False 来取消帮助模式。 (这不会触发 HelpComplete 事件。)

当用户在帮助模式下从字符的弹出菜单中选择命令时,服务器将删除菜单,使用命令的指定 HelpContextID 调用帮助,并发送此事件。 上下文敏感(也称为“这是什么?”)帮助窗口显示在指针位置。 如果用户通过语音输入选择命令,则“帮助”窗口会显示在字符上。 如果该字符不在屏幕上,窗口将显示在离该字符当前位置最近的屏幕上。

如果服务器返回 Name ("") 为空字符串,则表示用户选择了服务器提供的命令。

此事件仅发送到将字符置于帮助模式的客户端应用程序。

另请参阅

HelpModeOn 属性HelpContextID 属性