HelpDisplay 类

在使用的帮助系统中创建一个链接。

继承层次

Object
VObject
HelpDisplay

命名空间： XSharp.VO.SDK
程序集： XSharp.VOGUIClasses (在 XSharp.VOGUIClasses.dll 中) 版本：2.22 GA

语法

复制

 CLASS HelpDisplay INHERIT VObject

public class HelpDisplay : VObject

查看代码

HelpDisplay 类型公开以下成员。

构造函数

	名称	说明
	HelpDisplay	为指定的帮助数据库构造一个帮助显示。

Top

方法

	名称	说明
	HelpError	确定上一次 HelpDisplay 操作是否成功。
	Show	指示帮助系统提供与给定关键字相关联的帮助主题。

Top

字段

	名称	说明
	DefaultPageOnContents
	oCargo	Cargo slot. (继承自 VObject。)
	Win32Processing

Top

备注

HelpDisplay 类允许您轻松为应用程序提供在线帮助。GUI 提供的帮助系统资源可以保留在内存中，直到删除 HelpDisplay 对象。因此，在应用程序终止之前，请确保删除或使 HelpDisplay 对象超出范围。
HelpDisplay 提供了一种在给定主题上显示帮助的方法。但是，应用程序仍然需要一种方法来确定需要哪个主题的帮助。对于大型应用程序，大多数 GUI 风格指南建议从菜单栏提供帮助命令。这些命令可以通过 MenuCommandEvent 处理，以响应地显示适当的帮助信息。另一种方法是使用推按钮来获取特定主题的帮助。使用推按钮和 ButtonClick() 事件处理，您可以在按下帮助按钮时，编程应用程序显示相关的帮助信息。实际上，应用程序的帮助功能应该结合菜单命令和按钮，以提供帮助。
上下文相关的帮助意味着用户在选择帮助键或鼠标序列时，会收到与当前活动相关的帮助。例如，当响应对话框窗口时，用户可能需要焦点控件的帮助。 X# 应用程序可以为以下内容提供上下文相关的帮助：
屏幕的特定区域(如标题栏和画布区域) 菜单命令控件(如推按钮、编辑控件和工具栏按钮)
为了支持一个可移植的上下文相关的帮助系统，X# 提供了 HelpRequestEvent 类，Window:HelpDisplay 属性和 Window:HelpRequest() 事件处理方法。 (HelpRequest() 确定帮助触发器的来源，即请求帮助的特定项目，并将此信息传递给 GUI 的帮助系统。)
有关如何为应用程序编程在线帮助系统的更多信息，请参阅程序员指南中的"GUI类"章节。

提示：
EXPORTed 变量 DefaultPageOnContents 是一个 LOGIC，默认为 TRUE。它用于确定是否在请求 HelpContents 时应显示默认页面。如果设置为 FALSE，'HelpContents'将显示内容选项卡，但保留当前主题的显示。仅适用于 HTML 帮助。

示例

下面的例子处理了两个常见的菜单命令，帮助索引和使用帮助：

复制

 1CLASS MyWindow INHERIT TopAppWindow
 2    METHOD Init() CLASS MyWindow
 3        SUPER:Init()
 4        SELF:HelpDisplay := HelpDisplay{"mywind.hlp"}
 5
 6    METHOD MenuCommand(oMCE) CLASS MyWindow
 7        LOCAL nItemID := oMCE:ItemID
 8
 9        DO CASE
10            CASE nItemID = IDM_MENU_HELP_INDEX_ID
11                SELF:HelpDisplay:Show("HelpIndex")
12
13            CASE nItemID = IDM_MENU_HELP_USINGHELP_ID
14                SELF:HelpDisplay:Show("HelpOnHelp")
15
16            OTHERWISE
17                SUPER:MenuCommand(oMCE)
18        ENDCASE

参见

引用

XSharp.VO.SDK 命名空间