Help.ShowHelp Méthode

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Affiche le contenu d'un fichier d'aide.

Surcharges

ShowHelp(Control, String)	Affiche le contenu du fichier d'aide situé à l'adresse URL spécifiée.
ShowHelp(Control, String, String)	Affiche le contenu du fichier d'aide trouvé à l'URL spécifiée pour un mot clé spécifique.
ShowHelp(Control, String, HelpNavigator)	Affiche le contenu du fichier d'aide trouvé à l'URL spécifiée pour une rubrique spécifique.
ShowHelp(Control, String, HelpNavigator, Object)	Affiche le contenu du fichier d'aide situé à l'adresse URL fournie par l'utilisateur.

ShowHelp(Control, String)

Affiche le contenu du fichier d'aide situé à l'adresse URL spécifiée.

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)

Paramètres

parent

Control

Control qui identifie le parent de la boîte de dialogue Aide.

url

String

Chemin d'accès et nom du fichier d'aide.

Exemples

L’exemple de code suivant illustre la ShowHelp méthode. Pour exécuter cet exemple, collez le code suivant dans un formulaire qui contient un bouton nommé 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

Remarques

L’argument url peut être de la forme C:\path\sample.chm ou /folder/file.htm. Pour plus d’informations sur le format des chemins d’accès, consultez Formats de chemin d’accès aux fichiers sur les systèmes Windows.

Voir aussi

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Affiche le contenu du fichier d'aide trouvé à l'URL spécifiée pour un mot clé spécifique.

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)

Paramètres

parent

Control

Control qui identifie le parent de la boîte de dialogue Aide.

url

String

Chemin d'accès et nom du fichier d'aide.

keyword

String

Mot clé de recherche de l'aide à afficher.

Exemples

L’exemple de code suivant affiche un formulaire avec trois boutons qui peuvent être utilisés pour interagir avec le fichier d’aide mspaint.chm. Le bouton Afficher l’index d’aide affiche l’onglet Index pour le fichier d’aide. Le bouton Afficher l’aide affiche le contenu du fichier d’aide en fonction de la valeur sélectionnée dans la liste du Navigateur d’aide . Le bouton Afficher le mot clé affiche le contenu du fichier d’aide en fonction de la mot clé spécifiée dans la zone de texte Mot clé.

Par exemple, pour afficher la page d’aide ovales par la valeur d’index, sélectionnez la HelpNavigator.KeywordIndex valeur dans la liste déroulante Navigateur d’aide , tapez ovales dans la zone de texte Paramètre , puis cliquez sur le bouton Afficher l’aide . Pour afficher la rubrique d’aide « Pour peindre au pinceau » par le mot clé, tapez mspaint.chm::/paint_brush.htm dans la zone de texte Mot clé, puis cliquez sur le bouton Afficher le mot clé.

Cet exemple montre uniquement l’appel à la ShowHelp méthode. Consultez la vue d’ensemble Help de la classe pour obtenir l’exemple de code complet.

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

Remarques

L’argument url peut être de la forme C:\path\sample.chm ou /folder/file.htm. Pour plus d’informations sur le format des chemins d’accès, consultez Formats de chemin d’accès aux fichiers sur les systèmes Windows.

Si keyword a la valeur null, la table des matières du fichier d’aide s’affiche.

Voir aussi

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Affiche le contenu du fichier d'aide trouvé à l'URL spécifiée pour une rubrique spécifique.

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)

Paramètres

parent

Control

Control qui identifie le parent de la boîte de dialogue Aide.

url

String

Chemin d'accès et nom du fichier d'aide.

navigator

HelpNavigator

Une des valeurs de l'objet HelpNavigator.

Exemples

L’exemple de code suivant montre comment utiliser la ShowHelp méthode pour ouvrir un fichier d’aide sur sa page d’index. Pour exécuter cet exemple, collez le code suivant dans un formulaire qui contient un bouton nommé 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

Remarques

L’argument url peut être de la forme C:\path\sample.chm ou /folder/file.htm. Pour plus d’informations sur le format des chemins d’accès, consultez Formats de chemin d’accès aux fichiers sur les systèmes Windows.

Les fichiers d’aide compilés fournissent des liens de table des matières, d’index, de recherche et de mot clé dans des pages. Vous pouvez utiliser les valeurs suivantes pour l’argument navigator : HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexou HelpNavigator.Topic.

Voir aussi

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

Affiche le contenu du fichier d'aide situé à l'adresse URL fournie par l'utilisateur.

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)

Paramètres

parent

Control

Control qui identifie le parent de la boîte de dialogue Aide.

url

String

Chemin d'accès et nom du fichier d'aide.

command

HelpNavigator

Une des valeurs de l'objet HelpNavigator.

parameter

Object

Chaîne qui contient l'identificateur de rubrique.

Exceptions

ArgumentException

parameter est un entier.

Exemples

L’exemple de code suivant affiche un formulaire avec trois boutons qui peuvent être utilisés pour interagir avec le fichier d’aide mspaint.chm. Le bouton Afficher l’index d’aide affiche l’onglet Index pour le fichier d’aide. Le bouton Afficher l’aide affiche le contenu du fichier d’aide en fonction de la valeur sélectionnée dans la liste du Navigateur d’aide . Le bouton Afficher le mot clé affiche le contenu du fichier d’aide en fonction de la mot clé spécifiée dans la zone de texte Mot clé.

Par exemple, pour afficher la page d’aide ovales par la valeur d’index, sélectionnez la HelpNavigator.KeywordIndex valeur dans la liste déroulante Navigateur d’aide , tapez ovales dans la zone de texte Paramètre , puis cliquez sur le bouton Afficher l’aide . Pour afficher la rubrique d’aide « Pour peindre au pinceau » par le mot clé, tapez mspaint.chm::/paint_brush.htm dans la zone de texte Mot clé, puis cliquez sur le bouton Afficher le mot clé.

Cet exemple montre uniquement l’appel à la ShowHelp méthode. Consultez la vue d’ensemble Help de la classe pour obtenir l’exemple de code complet.

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

Remarques

L’argument url peut être de la forme C:\path\sample.chm ou /folder/file.htm. Pour plus d’informations sur le format des chemins d’accès, consultez Formats de chemin d’accès aux fichiers sur les systèmes Windows.

Les fichiers d’aide compilés fournissent des liens de table des matières, d’index, de recherche et de mot clé dans des pages. Vous pouvez utiliser l’argument parameter pour fournir un affinement supplémentaire de la HelpNavigator.Topiccommande , HelpNavigator.TopicId, HelpNavigator.KeywordIndexou HelpNavigator.AssociateIndex . Si la valeur spécifiée dans l’argument command est HelpNavigator.TableOfContents, HelpNavigator.Indexou HelpNavigator.Find, cette valeur doit être une chaîne vide («  », ou String.Empty). Si l’argument command fait référence HelpNavigator.Topicà , HelpNavigator.TopicId, HelpNavigator.KeywordIndexou HelpNavigator.AssociateIndex, cette valeur doit être une chaîne qui contient le nom de la rubrique ou l’identificateur mot clé ou numérique de la rubrique à afficher.

Voir aussi

• ShowHelpIndex(Control, String)