Help 类

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

封装 HTML 帮助 1.0 引擎。

C#

public static class Help

继承

Object

Help

示例

下面的代码示例显示一个窗体，其中包含可用于与 Mspaint.chm 帮助文件交互的三个按钮。 “ 显示帮助索引 ”按钮显示帮助文件的“ 索引 ”选项卡。 “ 显示帮助 ”按钮根据在“帮助 导航器 ”列表中选择的值显示帮助文件中的内容。 “ 显示关键字 ”按钮根据“ 关键字 ”文本框中指定的关键字显示帮助文件中的内容。

例如，若要按索引值显示“椭圆形帮助”页，请在“帮助导航器”下拉列表中选择HelpNavigator.KeywordIndex该值，在“参数”文本框中键入“椭圆”，然后单击“显示帮助”按钮。 若要按关键字显示“使用画笔绘制”帮助主题，请在“关键字”文本框中键入 mspaint.chm：：/paint_brush.htm，然后单击“显示关键字”按钮。

该示例使用 ShowHelp 方法显示不同的帮助选项卡和帮助主题，并使用 ShowHelpIndex 方法显示帮助索引。

C#

using System;
using System.Drawing;
using System.ComponentModel;
using System.Windows.Forms;

public class Form1 : System.Windows.Forms.Form
{
    private const string helpfile = "mspaint.chm";
    private System.Windows.Forms.Button showIndex;
    private System.Windows.Forms.Button showHelp;
    private System.Windows.Forms.Label label1;
    private System.Windows.Forms.ComboBox navigatorCombo;
    private System.Windows.Forms.Button showKeyword;
    private System.Windows.Forms.TextBox keyword;
    private System.Windows.Forms.Label label2;
    private System.Windows.Forms.Label label3;
    private System.Windows.Forms.TextBox parameterTextBox;

    [STAThread]
    static void Main() 
    {
        Application.Run(new Form1());
    }

    public Form1()
    {
        this.showIndex = new System.Windows.Forms.Button();
        this.showHelp = new System.Windows.Forms.Button();
        this.navigatorCombo = new System.Windows.Forms.ComboBox();
        this.label1 = new System.Windows.Forms.Label();
        this.showKeyword = new System.Windows.Forms.Button();
        this.keyword = new System.Windows.Forms.TextBox();
        this.label2 = new System.Windows.Forms.Label();
        this.label3 = new System.Windows.Forms.Label();
        this.parameterTextBox = new System.Windows.Forms.TextBox();

        // Help Navigator Label
        this.label1.Location = new System.Drawing.Point(112, 64);
        this.label1.Size = new System.Drawing.Size(168, 16);
        this.label1.Text = "Help Navigator:";

        // Keyword Label
        this.label2.Location = new System.Drawing.Point(120, 184);
        this.label2.Size = new System.Drawing.Size(100, 16);
        this.label2.Text = "Keyword:";

        // Parameter Label
        this.label3.Location = new System.Drawing.Point(112, 120);
        this.label3.Size = new System.Drawing.Size(168, 16);
        this.label3.Text = "Parameter:";

        // Show Index Button
        this.showIndex.Location = new System.Drawing.Point(16, 16);
        this.showIndex.Size = new System.Drawing.Size(264, 32);
        this.showIndex.TabIndex = 0;
        this.showIndex.Text = "Show Help Index";
        this.showIndex.Click += new System.EventHandler(this.showIndex_Click);

        // Show Help Button
        this.showHelp.Location = new System.Drawing.Point(16, 80);
        this.showHelp.Size = new System.Drawing.Size(80, 80);
        this.showHelp.TabIndex = 1;
        this.showHelp.Text = "Show Help";
        this.showHelp.Click += new System.EventHandler(this.showHelp_Click);

        // Show Keyword Button
        this.showKeyword.Location = new System.Drawing.Point(16, 192);
        this.showKeyword.Size = new System.Drawing.Size(88, 32);
        this.showKeyword.TabIndex = 4;
        this.showKeyword.Text = "Show Keyword";
        this.showKeyword.Click += new System.EventHandler(this.showKeyword_Click);

        // Help Navigator ComboBox
        this.navigatorCombo.DropDownStyle = System.Windows.Forms.ComboBoxStyle.DropDownList;
        this.navigatorCombo.Location = new System.Drawing.Point(112, 80);
        this.navigatorCombo.Size = new System.Drawing.Size(168, 21);
        this.navigatorCombo.TabIndex = 2;

        // Keyword TextBox
        this.keyword.Location = new System.Drawing.Point(120, 200);
        this.keyword.Size = new System.Drawing.Size(160, 20);
        this.keyword.TabIndex = 5;
        this.keyword.Text = "";

        // Parameter TextBox
        this.parameterTextBox.Location = new System.Drawing.Point(112, 136);
        this.parameterTextBox.Size = new System.Drawing.Size(168, 20);
        this.parameterTextBox.TabIndex = 8;
        this.parameterTextBox.Text = "";

        // Set up how the form should be displayed and add the controls to the form.
        this.ClientSize = new System.Drawing.Size(292, 266);
        this.Controls.AddRange(new System.Windows.Forms.Control[] {
                                        this.parameterTextBox, this.label3,
                                        this.label2, this.keyword,
                                        this.showKeyword, this.label1,
                                        this.navigatorCombo, this.showHelp,
                                        this.showIndex});
        this.FormBorderStyle = System.Windows.Forms.FormBorderStyle.FixedDialog;
        this.Text = "Help App";

        // Load the various values of the HelpNavigator enumeration
        // into the combo box.
        TypeConverter converter;
        converter = TypeDescriptor.GetConverter(typeof(HelpNavigator));
        foreach(object value in converter.GetStandardValues()) 
        {
            navigatorCombo.Items.Add(value);
        }
    }

    private void showIndex_Click(object sender, System.EventArgs e)
    {
        // Display the index for the help file.
        Help.ShowHelpIndex(this, helpfile);
    }
    private void showHelp_Click(object sender, System.EventArgs e)
    {
        // Display Help using the Help navigator enumeration
        // that is selected in the combo box. Some enumeration
        // values make use of an extra parameter, which can
        // be passed in through the Parameter text box.
        HelpNavigator navigator = HelpNavigator.TableOfContents;
        if (navigatorCombo.SelectedItem != null)
        {
            navigator = (HelpNavigator)navigatorCombo.SelectedItem;
        }
        Help.ShowHelp(this, helpfile, navigator, parameterTextBox.Text);
    }
    private void showKeyword_Click(object sender, System.EventArgs e)
    {
        // Display help using the provided keyword.
        Help.ShowHelp(this, helpfile, keyword.Text);
    }
}

注解

不能创建 类的新实例 Help 。 若要为应用程序提供帮助，请调用静态 ShowHelp 和 ShowHelpIndex 方法。

可以使用 Help 显示编译的帮助文件 (.chm) 或 HTML 帮助格式的 HTML 文件。 编译的帮助文件在页面中提供目录、索引、搜索功能和关键字链接。 快捷方式仅适用于已编译的帮助文件。

可以使用 HTML 帮助研讨会生成 HTML 帮助 1.x 文件。 有关 HTML 帮助的详细信息，请参阅Microsoft HTML 帮助中的“HTML 帮助研讨会”和其他 HTML 帮助主题。

方法

ShowHelp(Control, String)	显示指定 URL 处的帮助文件内容。
ShowHelp(Control, String, HelpNavigator)	显示在指定 URL 处找到的有关特定主题的帮助文件内容。
ShowHelp(Control, String, HelpNavigator, Object)	显示位于用户提供的 URL 处的帮助文件内容。
ShowHelp(Control, String, String)	显示在指定 URL 处找到的有关特定关键字的帮助文件内容。
ShowHelpIndex(Control, String)	显示指定帮助文件的索引。
ShowPopup(Control, String, Point)	显示一个“帮助”弹出窗口。

适用于

另请参阅

• HelpNavigator
• HelpProvider