Help.ShowHelp Metodo

Definizione

Spazio dei nomi:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Visualizza il contenuto di un file della Guida.

Overload

ShowHelp(Control, String)	Visualizza il contenuto del file della Guida all'URL specificato.
ShowHelp(Control, String, String)	Visualizza il contenuto del file della Guida all'URL specificato per una parola chiave specifica.
ShowHelp(Control, String, HelpNavigator)	Visualizza il contenuto del file della Guida all'URL specificato per un argomento specifico.
ShowHelp(Control, String, HelpNavigator, Object)	Visualizza il contenuto del file della Guida all'URL specificato fornito dall’utente.

ShowHelp(Control, String)

Visualizza il contenuto del file della Guida all'URL specificato.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url);

static member ShowHelp : System.Windows.Forms.Control * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String)

Parametri

parent

Control

Oggetto Control che identifica la finestra di dialogo padre della finestra di dialogo della Guida.

url

String

Il percorso e il nome del file della Guida.

Esempio

Nell'esempio di codice seguente viene illustrato il ShowHelp metodo . Per eseguire questo esempio, incollare il codice seguente in un modulo contenente un pulsante denominato Button1.

// Open the Help file for the Character Map topic.  
void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm" );
}

// Open the Help file for the Character Map topic.  
private void Button1_Click(System.Object sender, System.EventArgs e)
{

    Help.ShowHelp(TextBox1, "file://c:\\charmap.chm");
}

' Open the Help file for the Character Map topic.  
Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm")
End Sub

Commenti

L'argomento url può essere del formato C:\path\sample.chm o /folder/file.htm. Per informazioni sul formato dei percorsi, vedere Formati percorso file nei sistemi Windows.

Vedi anche

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Visualizza il contenuto del file della Guida all'URL specificato per una parola chiave specifica.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::String ^ keyword);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, string? keyword);

static member ShowHelp : System.Windows.Forms.Control * string * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, keyword As String)

Parametri

parent

Control

Oggetto Control che identifica la finestra di dialogo padre della finestra di dialogo della Guida.

url

String

Il percorso e il nome del file della Guida.

keyword

String

La parola chiave per la quale visualizzare la Guida.

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 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 Guidaovali in base al valore dell'indice, selezionare il HelpNavigator.KeywordIndex valore 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 .

In questo esempio viene visualizzata solo la chiamata al ShowHelp metodo . Vedere la panoramica della classe per l'esempio Help di codice completo.

void showKeyword_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Display help using the provided keyword.
   Help::ShowHelp( this, helpfile, keyword->Text );
}

private void showKeyword_Click(object sender, System.EventArgs e)
{
    // Display help using the provided keyword.
    Help.ShowHelp(this, helpfile, keyword.Text);
}

Private Sub showKeyword_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showKeyword.Click
    ' Display Help using the provided keyword. 
    Help.ShowHelp(Me, helpfile, keyword.Text)
End Sub

Commenti

L'argomento url può essere del formato C:\path\sample.chm o /folder/file.htm. Per informazioni sul formato dei percorsi, vedere Formati percorso file nei sistemi Windows.

Se keyword è null, verrà visualizzato il sommario per il file della Guida.

Vedi anche

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Visualizza il contenuto del file della Guida all'URL specificato per un argomento specifico.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator navigator);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator navigator);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, navigator As HelpNavigator)

Parametri

parent

Control

Oggetto Control che identifica la finestra di dialogo padre della finestra di dialogo della Guida.

url

String

Il percorso e il nome del file della Guida.

navigator

HelpNavigator

Uno dei valori di HelpNavigator.

Esempio

Nell'esempio di codice seguente viene illustrato come usare il ShowHelp metodo per aprire un file della Guida nella relativa pagina di indice. Per eseguire questo esempio, incollare il codice seguente in un modulo contenente un pulsante denominato Button2.

// Open the Help file for the Character Map topic and 
// display the Index page.
void Button2_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm", HelpNavigator::Index );
}

// Open the Help file for the Character Map topic and 
// display the Index page.
private void Button2_Click(System.Object sender, System.EventArgs e)
{

    Help.ShowHelp(TextBox1, "file://c:\\charmap.chm", 
        HelpNavigator.Index);
}

' Open the Help file for the Character Map topic and 
' display the Index page.
Private Sub Button2_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button2.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm", HelpNavigator.Index)
End Sub

Commenti

L'argomento url può essere del formato C:\path\sample.chm o /folder/file.htm. Per informazioni sul formato dei percorsi, vedere Formati percorso file nei sistemi Windows.

I file della Guida compilati forniscono un sommario, un indice, una ricerca e i collegamenti alle parole chiave nelle pagine. È possibile usare i valori seguenti per l'argomento navigator : HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexo HelpNavigator.Topic.

Vedi anche

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

Visualizza il contenuto del file della Guida all'URL specificato fornito dall’utente.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ parameter);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator command, object? parameter);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator * obj -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, parameter As Object)

Parametri

parent

Control

Oggetto Control che identifica la finestra di dialogo padre della finestra di dialogo della Guida.

url

String

Il percorso e il nome del file della Guida.

command

HelpNavigator

Uno dei valori di HelpNavigator.

parameter

Object

Stringa che contiene l'identificatore di argomento.

Eccezioni

ArgumentException

parameter è un Integer.

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 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 Guidaovali in base al valore dell'indice, selezionare il HelpNavigator.KeywordIndex valore 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 .

In questo esempio viene visualizzata solo la chiamata al ShowHelp metodo . Vedere la panoramica della classe per l'esempio Help di codice completo.

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 != nullptr )
   {
      navigator =  *safe_cast<HelpNavigator^>(navigatorCombo->SelectedItem);
   }

   Help::ShowHelp( this, helpfile, navigator, parameterTextBox->Text );
}

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 Sub showHelp_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showHelp.Click
    ' 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.
    Dim navigator As HelpNavigator = HelpNavigator.TableOfContents
    If (navigatorCombo.SelectedItem IsNot Nothing) Then
        navigator = CType(navigatorCombo.SelectedItem, HelpNavigator)
    End If
    Help.ShowHelp(Me, helpfile, navigator, parameterTextBox.Text)
End Sub

Commenti

L'argomento url può essere del formato C:\path\sample.chm o /folder/file.htm. Per informazioni sul formato dei percorsi, vedere Formati percorso file nei sistemi Windows.

I file della Guida compilati forniscono collegamenti di tabella, indice, ricerca e parola chiave nelle pagine. È possibile usare l'argomento parameter per fornire ulteriori miglioramenti del HelpNavigator.Topiccomando , , HelpNavigator.TopicIdHelpNavigator.KeywordIndexo HelpNavigator.AssociateIndex . Se il valore specificato nell'argomento command è HelpNavigator.TableOfContents, o HelpNavigator.IndexHelpNavigator.Find, questo valore deve essere una stringa vuota ("", o String.Empty). Se l'argomento command fa riferimento HelpNavigator.Topica , HelpNavigator.TopicId, HelpNavigator.KeywordIndexo HelpNavigator.AssociateIndex, questo valore deve essere una stringa contenente il nome dell'argomento o la parola chiave o l'identificatore numerico dell'argomento da visualizzare.

Vedi anche

• ShowHelpIndex(Control, String)