HelpNavigator Enumeration

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gibt Konstanten an, die die anzuzeigenden Elemente der Hilfedatei angeben.

public enum HelpNavigator

Vererbung

Object

ValueType

Enum

HelpNavigator

Felder

AssociateIndex	-2147483643	Die Hilfedatei wird mit dem Indexeintrag für den ersten Buchstaben eines angegebenen Themas geöffnet.
Find	-2147483644	Die Hilfedatei wird auf der Suchseite geöffnet.
Index	-2147483645	Die Hilfedatei wird mit dem Index geöffnet.
KeywordIndex	-2147483642	Die Hilfedatei wird mit dem Thema mit dem angegebenen Indexeintrag geöffnet, sofern dieser vorhanden ist. Ansonsten wird der Indexeintrag angezeigt, der dem angegebenen Schlüsselwort am nächsten liegt.
TableOfContents	-2147483646	Die Hilfedatei wird mit dem Inhaltsverzeichnis geöffnet.
Topic	-2147483647	Die Hilfedatei wird mit einem angegebenen Thema geöffnet, sofern dieses vorhanden ist.
TopicId	-2147483641	Die Hilfedatei wird mit einem von einem numerischen Themenbezeichner angegebenen Thema geöffnet.

Beispiele

Im folgenden Codebeispiel wird ein Formular mit drei Schaltflächen angezeigt, mit denen die mspaint.chm-Hilfedatei interagiert werden kann. Auf der Schaltfläche " Hilfeindex anzeigen " wird die Registerkarte "Index " für die Hilfedatei angezeigt. Auf der Schaltfläche " Hilfe anzeigen" werden Inhalte in der Hilfedatei basierend auf dem in der Hilfenavigatorliste ausgewählten Wert angezeigt. Auf der Schaltfläche " Schlüsselwort anzeigen" werden Inhalte in der Hilfedatei basierend auf dem im Textfeld "Schlüsselwort " angegebenen Schlüsselwort angezeigt.

Wenn Sie z. B. die Ovals-Hilfeseite anhand des Indexwerts anzeigen möchten, wählen Sie den SchlüsselwortIndex-Wert in der Dropdownliste " Help Navigator " aus, geben Sie Ovale in das Textfeld "Parameter " ein, und klicken Sie dann auf die Schaltfläche " Hilfe anzeigen ". Um das Hilfethema "Zum Zeichnen mit einem Pinsel" durch das Schlüsselwort anzuzeigen, geben Sie mspaint.chm::/paint_brush.htm im Textfeld "Schlüsselwort anzeigen" ein, und klicken Sie dann auf die Schaltfläche "Schlüsselwort anzeigen ".

Im Beispiel wird die ShowHelp Methode verwendet, um die verschiedenen Hilferegisterkarten und Hilfethemen anzuzeigen, und die ShowHelpIndex Methode zum Anzeigen des Hilfeindexes.

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);
    }
}

Hinweise

Diese Aufzählung wird von den Help Klassen verwendet HelpProvider , um Zugriff auf bestimmte Elemente einer Hilfedatei bereitzustellen. Wenn sie beispielsweise mit der Komponente verwendet werden, die HelpProvider F1-Hilfe bereitstellt, kann der TopicId- oder Topic-Wert angegeben werden, um Hilfe zu einem kontextspezifischen Thema zu öffnen.

Gilt für