Exporter (0) Imprimer
Développer tout
Cet article a fait l'objet d'une traduction automatique. Déplacez votre pointeur sur les phrases de l'article pour voir la version originale de ce texte. Informations supplémentaires.
Traduction
Source

HelpProvider, classe

Fournit une aide contextuelle ou en ligne pour les contrôles.

Espace de noms :  System.Windows.Forms
Assembly :  System.Windows.Forms (dans System.Windows.Forms.dll)

public class HelpProvider : Component, 
	IExtenderProvider

Le type HelpProvider expose les membres suivants.

  NomDescription
Méthode publiqueHelpProviderInitialise une nouvelle instance de la classe HelpProvider.
Début

  NomDescription
Propriété protégéeCanRaiseEventsObtient une valeur qui indique si le composant peut déclencher un événement. (Hérité de Component.)
Propriété publiqueContainerObtient le IContainer qui contient Component. (Hérité de Component.)
Propriété protégéeDesignModeObtient une valeur qui indique si Component est actuellement en mode design. (Hérité de Component.)
Propriété protégéeEventsObtient la liste des gestionnaires d'événements attachés à ce Component. (Hérité de Component.)
Propriété publiqueHelpNamespaceObtient ou définit une valeur qui spécifie le nom du fichier d'aide associé à cet objet HelpProvider.
Propriété publiqueSiteObtient ou définit le ISite de Component. (Hérité de Component.)
Propriété publiqueTagObtient ou définit l'objet qui contient les données supplémentaires relatives à HelpProvider.
Début

  NomDescription
Méthode publiqueCanExtendSpécifie si cet objet peut fournir ses propriétés extendeur à l'objet spécifié.
Méthode publiqueCreateObjRefCrée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject.)
Méthode publiqueDispose()Libère toutes les ressources utilisées par Component. (Hérité de Component.)
Méthode protégéeDispose(Boolean)Libère les ressources non managées utilisées par Component et libère éventuellement les ressources managées. (Hérité de Component.)
Méthode publiqueEquals(Object)Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
Méthode protégéeFinalizeLibère les ressources non managées et exécute d'autres opérations de nettoyage avant la récupération de Component par le garbage collection. (Hérité de Component.)
Méthode publiqueGetHashCodeSert de fonction de hachage par défaut. (Hérité de Object.)
Méthode publiqueGetHelpKeywordRetourne le mot clé d'aide pour le contrôle spécifié.
Méthode publiqueGetHelpNavigatorRetourne le paramètre HelpNavigator actuel pour le contrôle spécifié.
Méthode publiqueGetHelpStringRetourne la fenêtre d'affichage d'aide indépendante pour le contrôle spécifié.
Méthode publiqueGetLifetimeServiceRécupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
Méthode protégéeGetServiceRetourne un objet qui représente un service fourni par Component ou par son Container. (Hérité de Component.)
Méthode publiqueGetShowHelpRetourne une valeur indiquant si l'aide du contrôle spécifié doit être affichée.
Méthode publiqueGetTypeObtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publiqueInitializeLifetimeServiceObtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
Méthode protégéeMemberwiseClone()Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode protégéeMemberwiseClone(Boolean)Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject.)
Méthode publiqueResetShowHelpInfrastructure. Supprime l'aide associée au contrôle spécifié.
Méthode publiqueSetHelpKeywordSpécifie le mot clé qui permet de récupérer l'aide lorsque l'utilisateur fait appel à l'aide pour le contrôle spécifié.
Méthode publiqueSetHelpNavigatorSpécifie la commande d'aide qui permet de récupérer dans le fichier d'aide les informations relatives au contrôle spécifié.
Méthode publiqueSetHelpStringSpécifie la chaîne d'aide associée au contrôle spécifié.
Méthode publiqueSetShowHelpSpécifie si l'aide est affichée pour le contrôle spécifié.
Méthode publiqueToStringInfrastructure. Retourne une chaîne qui représente le HelpProvider en cours. (Substitue Component.ToString().)
Début

  NomDescription
Événement publicDisposedSe produit lorsque le composant est supprimé par un appel à la méthode Dispose. (Hérité de Component.)
Début

Chaque instance de HelpProvider gère une collection de références aux contrôles qui lui sont associés. Pour associer un fichier d'aide à HelpProvider, définissez la propriété HelpNamespace. Vous spécifiez le type d'aide fourni en appelant la méthode SetHelpNavigator et en fournissant une valeur HelpNavigator pour le contrôle spécifié. Vous fournissez le mot clé ou le sujet de l'aide en appelant la méthode SetHelpKeyword. Pour ouvrir l'aide à une rubrique spécifique, le mot clé doit être passé dans le formulaire topicName.htm.

Pour associer une chaîne d'aide à un contrôle, utilisez la méthode SetHelpString. La chaîne que vous associez à un contrôle en vous servant de cette méthode vient s'afficher dans une fenêtre indépendante quand l'utilisateur appuie sur la touche F1 alors que le contrôle a le focus.

Si la propriété HelpNamespace n'a pas été définie, vous devez utiliser la méthode SetHelpString pour fournir le texte d'aide. Si vous avez défini à la fois HelpNamespace et la chaîne d'aide, l'aide basée sur HelpNamespace est prioritaire.

HelpProvider appelle des méthodes sur la classe Help pour fournir les fonctionnalités d'aide.

L'exemple de code suivant illustre l'utilisation de la classe HelpProvider pour afficher l'aide contextuelle sur un formulaire contenant quatre champs d'adresse. L'exemple utilise la méthode SetHelpString pour définir le texte info-bulle de l'aide. Lorsque vous cliquez sur le bouton de l'aide contextuelle, puis sur un champ d'adresse avec le curseur d'aide, l'info-bulle de l'aide s'affiche avec le texte spécifié. Lorsque vous appuyez sur la touche F1 alors que le focus se trouve dans un champ d'adresse, le fichier d'aide mspaint.chm s'affiche, car la propriété HelpNamespace a la valeur mspaint.chm. La méthode SetShowHelp est appelée pour chaque contrôle d'adresse afin d'identifier qu'un contenu d'aide est disponible.


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

public class Form1 : System.Windows.Forms.Form
{
	private System.Windows.Forms.TextBox addressTextBox;
	private System.Windows.Forms.Label label2;
	private System.Windows.Forms.TextBox cityTextBox;
	private System.Windows.Forms.Label label3;
	private System.Windows.Forms.TextBox stateTextBox;
	private System.Windows.Forms.TextBox zipTextBox;
	private System.Windows.Forms.HelpProvider helpProvider1;
	private System.Windows.Forms.Label helpLabel;

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

	public Form1()
	{
        this.addressTextBox = new System.Windows.Forms.TextBox();
        this.helpLabel = new System.Windows.Forms.Label();
        this.label2 = new System.Windows.Forms.Label();
        this.cityTextBox = new System.Windows.Forms.TextBox();
        this.label3 = new System.Windows.Forms.Label();
        this.stateTextBox = new System.Windows.Forms.TextBox();
        this.zipTextBox = new System.Windows.Forms.TextBox();

        // Help Label
        this.helpLabel.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
        this.helpLabel.Location = new System.Drawing.Point(8, 80);
        this.helpLabel.Size = new System.Drawing.Size(272, 72);
        this.helpLabel.Text = "Click the Help button in the title bar, then click a control " + 
            "to see a Help tooltip for the control.  Click on a control and press F1 to invoke " +
            "the Help system with a sample Help file.";

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

        // Comma Label
        this.label3.Location = new System.Drawing.Point(136, 56);
        this.label3.Size = new System.Drawing.Size(16, 16);
        this.label3.Text = ",";

        // Create the HelpProvider.
        this.helpProvider1 = new System.Windows.Forms.HelpProvider();

        // Tell the HelpProvider what controls to provide help for, and
        // what the help string is.
        this.helpProvider1.SetShowHelp(this.addressTextBox, true);
        this.helpProvider1.SetHelpString(this.addressTextBox, "Enter the street address in this text box.");

        this.helpProvider1.SetShowHelp(this.cityTextBox, true);
        this.helpProvider1.SetHelpString(this.cityTextBox, "Enter the city here.");

        this.helpProvider1.SetShowHelp(this.stateTextBox, true);
        this.helpProvider1.SetHelpString(this.stateTextBox, "Enter the state in this text box.");

        this.helpProvider1.SetShowHelp(this.zipTextBox, true);
        this.helpProvider1.SetHelpString(this.zipTextBox, "Enter the zip code here.");

        // Set what the Help file will be for the HelpProvider.
        this.helpProvider1.HelpNamespace = "mspaint.chm";

        // Sets properties for the different address fields.

        // Address TextBox
        this.addressTextBox.Location = new System.Drawing.Point(16, 24);
        this.addressTextBox.Size = new System.Drawing.Size(264, 20);
        this.addressTextBox.TabIndex = 0;
        this.addressTextBox.Text = "";

        // City TextBox
        this.cityTextBox.Location = new System.Drawing.Point(16, 48);
        this.cityTextBox.Size = new System.Drawing.Size(120, 20);
        this.cityTextBox.TabIndex = 3;
        this.cityTextBox.Text = "";

        // State TextBox
        this.stateTextBox.Location = new System.Drawing.Point(152, 48);
        this.stateTextBox.MaxLength = 2;
        this.stateTextBox.Size = new System.Drawing.Size(32, 20);
        this.stateTextBox.TabIndex = 5;
        this.stateTextBox.Text = "";

        // Zip TextBox
        this.zipTextBox.Location = new System.Drawing.Point(192, 48);
        this.zipTextBox.Size = new System.Drawing.Size(88, 20);
        this.zipTextBox.TabIndex = 6;
        this.zipTextBox.Text = "";

        // Add the controls to the form.
        this.Controls.AddRange(new System.Windows.Forms.Control[] {
                                    this.zipTextBox, this.stateTextBox,
                                    this.label3, this.cityTextBox,
                                    this.label2, this.helpLabel,
                                    this.addressTextBox});

        // Set the form to look like a dialog, and show the HelpButton.    
        this.FormBorderStyle = System.Windows.Forms.FormBorderStyle.FixedDialog;
        this.HelpButton = true;
        this.MaximizeBox = false;
        this.MinimizeBox = false;
        this.ClientSize = new System.Drawing.Size(292, 160);
        this.Text = "Help Provider Demonstration";

    }
}


.NET Framework

Pris en charge dans : 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Pris en charge dans : 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (rôle principal du serveur non pris en charge), Windows Server 2008 R2 (rôle principal du serveur pris en charge avec SP1 ou version ultérieure ; Itanium non pris en charge)

Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Ajouts de la communauté

AJOUTER
Microsoft réalise une enquête en ligne pour recueillir votre opinion sur le site Web de MSDN. Si vous choisissez d’y participer, cette enquête en ligne vous sera présentée lorsque vous quitterez le site Web de MSDN.

Si vous souhaitez y participer,
Afficher:
© 2014 Microsoft