ToolTip Classe

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolTip.cs

Représente une petite fenêtre contextuelle rectangulaire qui affiche une brève description de l’objectif d’un contrôle lorsque l’utilisateur repose le pointeur sur le contrôle.

public ref class ToolTip : System::ComponentModel::Component, System::ComponentModel::IExtenderProvider

public class ToolTip : System.ComponentModel.Component, System.ComponentModel.IExtenderProvider

type ToolTip = class
    inherit Component
    interface IExtenderProvider

Public Class ToolTip
Inherits Component
Implements IExtenderProvider

Héritage

Object

MarshalByRefObject

Component

ToolTip

Implémente

IExtenderProvider

Exemples

L’exemple de code suivant crée une instance de la ToolTip classe et associe l’instance à celle Form dans laquelle l’instance est créée. Le code initialise ensuite les propriétés AutoPopDelayde délai, InitialDelayet ReshowDelay. En outre, l’instance de la ToolTip classe définit la ShowAlways propriété pour permettre au true texte info-bulle d’être toujours affiché, que le formulaire soit actif ou non. Enfin, l’exemple associe du texte info-bulle à deux contrôles sur un formulaire, un Button et un CheckBox. L’exemple de code nécessite que la méthode définie dans l’exemple se trouve dans un Form contrôle qui contient un Button contrôle nommé button1 et un CheckBox contrôle nommé checkBox1, et que la méthode est appelée à partir du constructeur du Form.

// This example assumes that the Form_Load event handling method
// is connected to the Load event of the form.
void Form1_Load( Object^ sender, System::EventArgs^ e )
{
   // Create the ToolTip and associate with the Form container.
   ToolTip^ toolTip1 = gcnew ToolTip;
   
   // Set up the delays for the ToolTip.
   toolTip1->AutoPopDelay = 5000;
   toolTip1->InitialDelay = 1000;
   toolTip1->ReshowDelay = 500;
   // Force the ToolTip text to be displayed whether or not the form is active.
   toolTip1->ShowAlways = true;
   
   // Set up the ToolTip text for the Button and Checkbox.
   toolTip1->SetToolTip( this->button1, "My button1" );
   toolTip1->SetToolTip( this->checkBox1, "My checkBox1" );
}

// This example assumes that the Form_Load event handling method
// is connected to the Load event of the form.
private void Form1_Load(object sender, System.EventArgs e)
{
   // Create the ToolTip and associate with the Form container.
   ToolTip toolTip1 = new ToolTip();

   // Set up the delays for the ToolTip.
   toolTip1.AutoPopDelay = 5000;
   toolTip1.InitialDelay = 1000;
   toolTip1.ReshowDelay = 500;
   // Force the ToolTip text to be displayed whether or not the form is active.
   toolTip1.ShowAlways = true;
      
   // Set up the ToolTip text for the Button and Checkbox.
   toolTip1.SetToolTip(this.button1, "My button1");
   toolTip1.SetToolTip(this.checkBox1, "My checkBox1");
}

' This example assumes that the Form_Load event handling method
' is connected to the Load event of the form.
Private Sub Form1_Load(sender As Object, e As System.EventArgs) Handles MyBase.Load
   ' Create the ToolTip and associate with the Form container.
   Dim toolTip1 As New ToolTip()
   
   ' Set up the delays for the ToolTip.
   toolTip1.AutoPopDelay = 5000
   toolTip1.InitialDelay = 1000
   toolTip1.ReshowDelay = 500
   ' Force the ToolTip text to be displayed whether or not the form is active.
   toolTip1.ShowAlways = True
   
   ' Set up the ToolTip text for the Button and Checkbox.
   toolTip1.SetToolTip(Me.button1, "My button1")
   toolTip1.SetToolTip(Me.checkBox1, "My checkBox1")
End Sub

Remarques

Avec la ToolTip classe, vous pouvez fournir des conseils à un utilisateur lorsque l’utilisateur place le pointeur sur un contrôle. La ToolTip classe est généralement utilisée pour alerter les utilisateurs à l’utilisation prévue d’un contrôle. Par exemple, vous pouvez spécifier du texte info-bulle pour un TextBox contrôle qui accepte un nom, en spécifiant le format du nom à taper dans le contrôle. En plus de fournir des indicateurs, vous pouvez également utiliser la ToolTip classe pour fournir des informations d’état d’exécution. Par exemple, vous pouvez utiliser la classe pour afficher la ToolTip vitesse de connexion et les données de qualité de ligne lorsque l’utilisateur déplace le pointeur sur un PictureBox contrôle qui affiche l’état de la connexion Internet.

La ToolTip classe peut être utilisée dans n’importe quel conteneur. Pour spécifier explicitement un conteneur, utilisez le ToolTip(IContainer) constructeur. Un composant unique ToolTip est généralement utilisé pour créer des info-bulles pour plusieurs contrôles sur un seul formulaire. Après avoir créé un ToolTip, utilisez un appel distinct à la méthode pour associer le texte d’affichage de l’info-bulle SetToolTip à un contrôle individuel. Ensuite, lorsque l’utilisateur déplace le pointeur sur un contrôle, l’info-bulle avec son texte s’affiche. Vous pouvez appeler SetToolTip plusieurs fois pour que le même contrôle modifie le texte associé au contrôle. Pour obtenir le texte associé à un contrôle, utilisez la GetToolTip méthode. Pour supprimer toutes les associations de texte Info-bulle avec une instance de la ToolTip classe, utilisez la RemoveAll méthode.

Note

Le texte d’info-bulle n’est pas affiché pour les contrôles désactivés. Sauf si la ShowAlways propriété est définie sur true, les info-bulles ne s’affichent pas lorsque leur conteneur est inactif.

La ToolTip classe fournit les propriétés et méthodes suivantes pour modifier le comportement et l’apparence par défaut d’une info-bulle.

Catégorie	Membres associés
Affichage manuel	Active, , Show, HideShowAlways, , PopupStopTimer
Minutage de l’info-bulle	AutoPopDelay, InitialDelay, , ReshowDelay, AutomaticDelay, StopTimer
Contenu	SetToolTip, , GetToolTip, StripAmpersandsToolTipIcon, , ToolTipTitleRemoveAll
Apparence	BackColor, , ForeColor, IsBalloonOwnerDraw, , UseAnimationUseFading

Si vous souhaitez désactiver tout le texte de l’info-bulle afin qu’il ne puisse pas être affiché dans votre application, vous pouvez utiliser la Active propriété. Généralement, l’info-bulle est dessinée par le système d’exploitation, mais pour personnaliser l’apparence du ToolTip, vous pouvez définir la OwnerDraw propriété true sur et gérer l’événement Draw .

La ToolTipTitle classe implémente l’interfaceSystem.ComponentModel.IExtenderProvider, qui a une seule méthode. CanExtend Les info-bulles étendent les contrôles sur le même formulaire au moment du design, en ajoutant une ToolTip propriété. Pour plus d’informations sur les fournisseurs d’extendeurs, consultez Fournisseurs d’extendeurs.

Constructeurs

Nom	Description
ToolTip()	Initialise une nouvelle instance du ToolTip conteneur sans conteneur spécifié.
ToolTip(IContainer)	Initialise une nouvelle instance de la ToolTip classe avec un conteneur spécifié.

Propriétés

Nom	Description
Active	Obtient ou définit une valeur indiquant si l’info-bulle est actuellement active.
AutomaticDelay	Obtient ou définit le délai automatique pour l’info-bulle.
AutoPopDelay	Obtient ou définit la période pendant laquelle l’info-bulle reste visible si le pointeur est stationnaire sur un contrôle avec du texte d’info-bulle spécifié.
BackColor	Obtient ou définit la couleur d’arrière-plan de l’info-bulle.
CreateParams	Obtient les paramètres de création de la fenêtre Info-bulle.
ForeColor	Obtient ou définit la couleur de premier plan de l’info-bulle.
InitialDelay	Obtient ou définit l’heure qui passe avant l’affichage de l’info-bulle.
IsBalloon	Obtient ou définit une valeur indiquant si l’info-bulle doit utiliser une fenêtre de bulle.
OwnerDraw	Obtient ou définit une valeur indiquant si l’info-bulle est dessinée par le système d’exploitation ou par le code que vous fournissez.
ReshowDelay	Obtient ou définit la durée qui doit se produire avant que les fenêtres d’info-bulle suivantes s’affichent lorsque le pointeur passe d’un contrôle à un autre.
ShowAlways	Obtient ou définit une valeur indiquant si une fenêtre Info-bulle est affichée, même si son contrôle parent n’est pas actif.
StripAmpersands	Obtient ou définit une valeur qui détermine la façon dont les caractères ampersand (&) sont traités.
Tag	Obtient ou définit l’objet qui contient des données fournies par le programmeur associées au ToolTip.
ToolTipIcon	Obtient ou définit une valeur qui définit le type d’icône à afficher en même temps que le texte info-bulle.
ToolTipTitle	Obtient ou définit un titre pour la fenêtre Info-bulle.
UseAnimation	Obtient ou définit une valeur déterminant si un effet d’animation doit être utilisé lors de l’affichage de l’info-bulle.
UseFading	Obtient ou définit une valeur déterminant si un effet de fondu doit être utilisé lors de l’affichage de l’info-bulle.

Méthodes

Nom	Description
CanExtend(Object)	Retourne true si l’info-bulle peut offrir une propriété d’extendeur au composant cible spécifié.
Dispose(Boolean)	Libère les ressources non managées utilisées par les Component ressources gérées et libère éventuellement les ressources managées.
Finalize()	Libère les ressources non managées et effectue d’autres opérations de nettoyage avant la Cursor récupération par le garbage collector.
GetToolTip(Control)	Récupère le texte d’info-bulle associé au contrôle spécifié.
Hide(IWin32Window)	Masque la fenêtre Info-bulle spécifiée.
RemoveAll()	Supprime tout le texte info-bulle actuellement associé au composant Info-bulle.
SetToolTip(Control, String)	Associe du texte info-bulle au contrôle spécifié.
Show(String, IWin32Window, Int32, Int32, Int32)	Définit le texte info-bulle associé au contrôle spécifié, puis affiche l’info-bulle pour la durée spécifiée à la position relative spécifiée.
Show(String, IWin32Window, Int32, Int32)	Définit le texte info-bulle associé au contrôle spécifié, puis affiche l’info-bulle modale à la position relative spécifiée.
Show(String, IWin32Window, Int32)	Définit le texte info-bulle associé au contrôle spécifié, puis affiche l’info-bulle pour la durée spécifiée.
Show(String, IWin32Window, Point, Int32)	Définit le texte info-bulle associé au contrôle spécifié, puis affiche l’info-bulle pour la durée spécifiée à la position relative spécifiée.
Show(String, IWin32Window, Point)	Définit le texte info-bulle associé au contrôle spécifié, puis affiche l’info-bulle modale à la position relative spécifiée.
Show(String, IWin32Window)	Définit le texte info-bulle associé au contrôle spécifié et affiche l’info-bulle modale.
StopTimer()	Arrête le minuteur qui masque les info-bulles affichées.
ToString()	Retourne une représentation sous forme de chaîne pour ce contrôle.

Événements

Nom	Description
Draw	Se produit lorsque l’info-bulle est dessinée et que la OwnerDraw propriété est définie true et que la IsBalloon propriété est false.
Popup	Se produit avant l’affichage initial d’une info-bulle. Il s’agit de l’événement par défaut pour la ToolTip classe.

Voir aussi

• ToolTipIcon
• HelpProvider
• Fournisseurs d’extendeurs
• ToolTip Component (Windows Forms)