HelpComplete 事件

  • 项目

[从 Windows 7 开始，Microsoft 代理已弃用，可能在后续版本的 Windows 中不可用。]

Description

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

语法

子代理。 (ByValCharacterID，ByVal ** Name**，ByVal** Cause**) **

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

备注

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

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

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

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

另请参阅

HelpModeOn 属性， HelpContextID 属性