ShellWindow.HelpRequest 方法 |  |
提供一个方法，当用户使用可用的上下文敏感帮助机制之一从应用程序请求帮助时，会调用该方法。
命名空间：
VO
程序集：
VOGUIClasses (在 VOGUIClasses.dll 中) 版本：2.22 GA
语法 VIRTUAL METHOD HelpRequest(
oHelpRequestEvent
) AS USUAL CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public override __Usual HelpRequest(
__Usual oHelpRequestEvent = default
)参数
- oHelpRequestEvent (Optional)
- 类型：__Usual
描述正在请求帮助的项目的 HelpRequestEvent 对象。
返回值
类型：
__Usual备注  提示： |
|---|
|
重要！这是一个由 X# 使用的回调方法。通常情况下，不应在您的应用程序代码中调用它。
|
只有在当前窗口(或其所有者之一)启用了帮助机制时，才会调用此事件处理程序。通过将 HelpDisplay 对象分配给窗口的 HelpDisplay 属性来启用帮助机制。
此事件处理程序的默认实现是在生成 HelpRequestEvent 的控件、菜单命令或窗口区域的帮助主题时显示帮助。这是通过使用 HelpDisplay:Show(<cKeyword>) 来实现的，其中 <cKeyword>是 HyperLabel:HelpContext 属性或在没有超级标签可用的情况下由此事件处理程序生成的默认关键字。
如果没有为项目生成超级标签，生成的关键字如下：
HELPCONTROL 请求生成的关键字是 Control_xxxx，其中 xxxx 是控件的数字ID，以十进制表示。例如，OK 按钮可能生成的关键字是 Control_101。
HELPMENU 请求生成的关键字是M enu_xxxx，其中 xxxx 是菜单命令的“清理”文本。清理文本已删除所有前导和尾随空格和和字符(&)的字符。此外，所有空格序列都替换为一个下划线，并且字符串在第一个制表符处截断。
例如，对于菜单命令： Save &As\tF3
是 Menu_Save_As HELPWINDOW request 生成下表中列出的关键字之一，
取决于拥有焦点的窗口区域。
| Keyword | Region |
|---|
| Window | Any area of the window not explicitly identified in this table |
| Window_Border | Border |
| Window_Caption | Title bar |
| Window_MaxBox | Maximize button |
| Window_MinBox | Minimize button |
| Window_SysMenuBox | System menu button |
| Window_Unknown | Any area of the window not explicitly identified in this table |
| Window_WindowCanvas | Canvas area |
| 提示： |
|---|
|
如果生成 Window_Unknown 关键字，HelpRequest() 的默认行为是显示 HelpDisplay 中定义的 Contents 主题(即，HelpDisplay:Show("HelpIndex"))。
|
如果接收到 HELPWINDOW 请求，同时 Window:HelpContext 已定义，Window:HelpRequest() 将使用 HelpContext 属性，而不管具有焦点的窗口区域是什么。有关如何为应用程序编程在线帮助系统的更多信息，请参阅程序员指南中的“GUI类”章节。
参见 
