C# 使用 HelpProvider 控件调用帮助文件

Posted 2021-12-04 dotNET跨平台

       HelpProvider控件可以将帮助文件(.htm文件或.chm文件)与 Windows 应用程序相关联，为特定对话框或对话框中的特定控件提供区分上下文的帮助，打开帮助文件到特定部分。如目录、索引或搜索功能的主页。如图1 所示为 HelpProvider 控件。

 图1    HelpProvider 控件 

       通过设置控件的 HelpNamespace 属性以及 SetShowHelp方法，实现当按F1 键时，打开指定的帮助文件。

       HelpNamespace 属性可以设置一个值，该值指定与 HelpProvider 对象关联的帮助文件名。

       语法如下:

   public virtual string HelpNamespace{get;set;}

       属性值：帮助文件的名称。

      SetShowHelp 方法用于指定是否显示指定控件的帮助信息。

       语法如下:

      public virtual void SetShowHelp(Control ctl,bool value)

         ctl：控制其帮助信息已打开或关闭。

        value：如果显示控件的帮助信息，则为true；否则为Fasle。

       说明

      如果没有对 HelpNamespace 属性进行设置，则必须使用 SetHelpString 方法提供帮助文本。

     【例1】创建一个 Windows 应用程序，首先在程序的根目录中建立一个命名为 helpPage.htm 的帮助文件，然后设置 HelpNamespace 属性是 helpPage.htm 文件的路径，最后设置控件的 SetShowHelp方法指定是否显示指定控件的帮助信息。

       代码如下:

private void Form1_Load(object sender,EventArgs e)
{
     //设置帮助文件的位置
     string strPath = Application.StartupPath.Substring(0,Application.StartupPath.Substring(0,Application. 
     StartupPath.LastIndexOf("\\\\")).LastIndexOf("\\\\"));
     strPath += @"\\helpPage.htm";
     //设置 helpProvider1 控件的 pNamespace 属性，以及帮助文件的路径
     helpProvider1.HelpNamespace = strPath;
     //设置 SetShowHelp 方法指定是否显示控件的帮助信息 
     helpProvider1.SetShowHelp(this,true);
 }

程序的运行结果如图2 所示。

图2    按F1键打开帮助文件

- END -

---

---

关注小编不迷路呦~

                                                                            欢迎留言