HelpNavigator Enumerazione

Definizione

Spazio dei nomi:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Specifica le costanti che indicano quali elementi del file della Guida visualizzare.

C#

public enum HelpNavigator

Ereditarietà

Object

ValueType

Enum

HelpNavigator

Campi

AssociateIndex	-2147483643	Il file della Guida viene aperto sulla voce dell'indice corrispondente alla prima lettera dell'argomento specificato.
Find	-2147483644	Il file della Guida viene aperto sulla pagina della ricerca.
Index	-2147483645	Il file della Guida viene aperto sull'indice.
KeywordIndex	-2147483642	Il file della Guida viene aperto sull'argomento con la voce di indice specificata, se esistente. In caso contrario verrà visualizzata la voce dell'indice più vicina alla parola chiave specificata.
TableOfContents	-2147483646	Il file della Guida viene aperto sul sommario.
Topic	-2147483647	Il file della Guida viene aperto su un argomento specificato, se esistente.
TopicId	-2147483641	Il file della Guida viene aperto sull'argomento indicato da un identificatore numerico dell'argomento.

Esempio

Nell'esempio di codice seguente viene visualizzato un modulo con tre pulsanti che possono essere usati per interagire con il file della Guida mspaint.chm. Il pulsante Mostra indice della Guida visualizza la scheda Indice per il file della Guida. Il pulsante Mostra guida visualizza il contenuto nel file della Guida in base al valore selezionato nell'elenco Guida guida . Il pulsante Mostra parola chiave visualizza il contenuto nel file della Guida in base alla parola chiave specificata nella casella di testo Parola chiave.

Ad esempio, per visualizzare la pagina Della Guida ovali in base al valore dell'indice, selezionare il valore KeywordIndex nell'elenco a discesa Guida guida, digitare ovali nella casella di testo Parametro e quindi fare clic sul pulsante Mostra guida. Per visualizzare l'argomento della Guida "Per disegnare con un pennello" nella parola chiave digitare mspaint.chm::/paint_brush.htm nella casella di testo Parola chiave e quindi fare clic sul pulsante Mostra parola chiave .

Nell'esempio viene usato il ShowHelp metodo per visualizzare le diverse schede della Guida e gli argomenti della Guida e il ShowHelpIndex metodo per visualizzare l'indice della Guida.

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

Commenti

Questa enumerazione viene usata dalle Help classi e HelpProvider per fornire l'accesso a elementi specifici di un file della Guida. Ad esempio, se usato con il HelpProvider componente che fornisce F1 Help, è possibile specificare il valore TopicId o Topic per aprire la Guida a un argomento specifico del contesto.

Si applica a