Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

HelpProvider classe

 

Date de publication : novembre 2016

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)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.HelpProvider

public class HelpProvider : Component, IExtenderProvider

NomDescription
System_CAPS_pubmethodHelpProvider()

Initialise une nouvelle instance de la classe HelpProvider.

NomDescription
System_CAPS_protpropertyCanRaiseEvents

Obtient une valeur indiquant si le composant peut déclencher un événement.(Hérité de Component.)

System_CAPS_pubpropertyContainer

Obtient les IContainer qui contient la Component.(Hérité de Component.)

System_CAPS_protpropertyDesignMode

Obtient une valeur qui indique si la Component est actuellement en mode design.(Hérité de Component.)

System_CAPS_protpropertyEvents

Obtient la liste des gestionnaires d’événements associés à cette Component.(Hérité de Component.)

System_CAPS_pubpropertyHelpNamespace

Obtient ou définit une valeur qui spécifie le nom du fichier d’aide associé à ce HelpProvider objet.

System_CAPS_pubpropertySite

Obtient ou définit le ISite de la Component.(Hérité de Component.)

System_CAPS_pubpropertyTag

Obtient ou définit l’objet qui contient les données supplémentaires sur le HelpProvider.

NomDescription
System_CAPS_pubmethodCanExtend(Object)

Spécifie si cet objet peut fournir ses propriétés extendeur à l’objet spécifié.

System_CAPS_pubmethodCreateObjRef(Type)

Crée un objet qui contient toutes les informations requises pour générer un proxy permettant de communiquer avec un objet distant.(Hérité de MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Libère toutes les ressources utilisées par Component.(Hérité de Component.)

System_CAPS_protmethodDispose(Boolean)

Libère les ressources non managées utilisées par Component et libère éventuellement les ressources managées.(Hérité de Component.)

System_CAPS_pubmethodEquals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.(Hérité de Object.)

System_CAPS_protmethodFinalize()

Libère les ressources non managées et exécute d'autres opérations de nettoyage avant la récupération du Component par le garbage collection.(Hérité de Component.)

System_CAPS_pubmethodGetHashCode()

Fait office de fonction de hachage par défaut.(Hérité de Object.)

System_CAPS_pubmethodGetHelpKeyword(Control)

Retourne le mot clé d’aide pour le contrôle spécifié.

System_CAPS_pubmethodGetHelpNavigator(Control)

Retourne l’actuel HelpNavigator définition pour le contrôle spécifié.

System_CAPS_pubmethodGetHelpString(Control)

Retourne le contenu de la fenêtre d’aide contextuelle pour le contrôle spécifié.

System_CAPS_pubmethodGetLifetimeService()

Récupère l’objet de service de durée de vie actuelle qui contrôle la stratégie de durée de vie de cette instance.(Hérité de MarshalByRefObject.)

System_CAPS_protmethodGetService(Type)

Retourne un objet qui représente un service fourni par Component ou par son Container.(Hérité de Component.)

System_CAPS_pubmethodGetShowHelp(Control)

Retourne une valeur indiquant si l’aide du contrôle spécifié doit être affiché.

System_CAPS_pubmethodGetType()

Obtient le Type de l'instance actuelle.(Hérité de Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtient 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.)

System_CAPS_protmethodMemberwiseClone()

Crée une copie superficielle du Object actuel.(Hérité de Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Crée une copie superficielle d’actuel MarshalByRefObject objet.(Hérité de MarshalByRefObject.)

System_CAPS_pubmethodResetShowHelp(Control)

Cette API prend en charge l’infrastructure de produit et n’est pas destinée à être utilisée directement depuis votre code. Supprime l’aide associée au contrôle spécifié.

System_CAPS_pubmethodSetHelpKeyword(Control, String)

Spécifie le mot clé utilisé pour récupérer l’aide lorsque l’utilisateur appelle l’aide pour le contrôle spécifié.

System_CAPS_pubmethodSetHelpNavigator(Control, HelpNavigator)

Spécifie la commande aide à utiliser lors de la récupération aide à partir du fichier d’aide pour le contrôle spécifié.

System_CAPS_pubmethodSetHelpString(Control, String)

Spécifie la chaîne d’aide associée au contrôle spécifié.

System_CAPS_pubmethodSetShowHelp(Control, Boolean)

Spécifie si l’aide est affichée pour le contrôle spécifié.

System_CAPS_pubmethodToString()

Cette API prend en charge l’infrastructure de produit et n’est pas destinée à être utilisée directement depuis votre code. Retourne une chaîne qui représente le HelpProvider actuel.(Remplace Component.ToString().)

NomDescription
System_CAPS_pubeventDisposed

Se produit lorsque le composant est supprimé par un appel à la Dispose (méthode).(Hérité de Component.)

Each instance of T:System.Windows.Forms.HelpProvider maintains a collection of references to controls associated with it. To associate a Help file with the T:System.Windows.Forms.HelpProvider, set the P:System.Windows.Forms.HelpProvider.HelpNamespace property. You specify the type of Help provided by calling the M:System.Windows.Forms.HelpProvider.SetHelpNavigator(System.Windows.Forms.Control,System.Windows.Forms.HelpNavigator) method and providing a T:System.Windows.Forms.HelpNavigator value for the specified control. You provide the keyword or topic for the Help by calling the M:System.Windows.Forms.HelpProvider.SetHelpKeyword(System.Windows.Forms.Control,System.String) method. To open Help to a specific topic, the keyword should be passed in the form topicName.htm.

To associate a specific Help string with a control, use the M:System.Windows.Forms.HelpProvider.SetHelpString(System.Windows.Forms.Control,System.String) method. The string that you associate with a control using this method is displayed in a pop-up window when the user presses the F1 key while the control has focus.

If the P:System.Windows.Forms.HelpProvider.HelpNamespace property has not been set, you must use the M:System.Windows.Forms.HelpProvider.SetHelpString(System.Windows.Forms.Control,System.String) method to provide the Help text. If you have set both P:System.Windows.Forms.HelpProvider.HelpNamespace and the Help string, Help based on the P:System.Windows.Forms.HelpProvider.HelpNamespace will take precedence.

HelpProvider calls methods on the Help class to provide Help functionality.

The following code example demonstrates using the T:System.Windows.Forms.HelpProvider class to display context-sensitive Help on a form containing four address fields. The example uses the M:System.Windows.Forms.HelpProvider.SetHelpString(System.Windows.Forms.Control,System.String) method to set the Help ToolTip text. When you use the context-sensitive Help button and click the Help cursor on an address field, the Help ToolTip appears with the specified text. When you press the F1 key with the focus in an address field, the mspaint.chm Help file is displayed because the P:System.Windows.Forms.HelpProvider.HelpNamespace property has been set to mspaint.chm. The M:System.Windows.Forms.HelpProvider.SetShowHelp(System.Windows.Forms.Control,System.Boolean) method is called for each address control to identify that it has Help content available.

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
Disponible depuis 1.1

Tous les membres statiques publics ( Shared en Visual Basic) de ce type sont thread-safe. Les membres d’instance n’ont pas la garantie d’être thread-safe.

Retour au début
Afficher: