ToolTip Classe

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

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

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 au Form dans lequel l’instance est créée. Le code initialise ensuite les propriétés AutoPopDelayde délai , InitialDelay, et ReshowDelay. En outre, l’instance de la ToolTip classe définit la ShowAlways propriété sur true pour permettre au texte d’info-bulle d’être toujours affiché, que le formulaire soit actif ou non. Enfin, l’exemple associe du texte d’info-bulle à deux contrôles sur un formulaire, un Button et un CheckBox. L’exemple de code exige que la méthode définie dans l’exemple se trouve dans un Form qui contient un Button contrôle nommé button1 et un CheckBox contrôle nommé checkBox1, et que la méthode soit 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 de l’utilisation prévue d’un contrôle. Par exemple, vous pouvez spécifier le texte d’info-bulle d’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 au moment de l’exécution. Par exemple, vous pouvez utiliser la classe pour afficher les ToolTip données de vitesse de connexion et 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 seul ToolTip composant 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 SetToolTip texte d’affichage d’info-bulle à 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 le même contrôle afin de modifier 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 d’info-bulle avec une instance de la ToolTip classe , utilisez la RemoveAll méthode .

Notes

Le texte de l’info-bulle n’est pas affiché pour les contrôles qui sont 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.

Category	Membres associés
Affichage manuel	Active, Show, Hide, ShowAlways, Popup, StopTimer
Minutage de l’info-bulle	AutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimer
Contenu	SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAll
Apparence	BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFading

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é . En règle générale, 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é sur true et gérer l’événement Draw .

La ToolTipTitle classe implémente l’interface System.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

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

Propriétés

Active	Obtient ou définit une valeur indiquant si l'info-bulle est actuellement active.
AutomaticDelay	Obtient ou définit le délai initial pour l'info-bulle.
AutoPopDelay	Obtient ou définit la durée d'affichage de l'info-bulle lorsque le pointeur de la souris s'immobilise sur un contrôle contenant le texte d'info-bulle spécifié.
BackColor	Obtient ou définit la couleur d'arrière-plan de l'info-bulle.
CanRaiseEvents	Obtient une valeur qui indique si le composant peut déclencher un événement. (Hérité de Component)
Container	Obtient le IContainer qui contient la Component. (Hérité de Component)
CreateParams	Obtient les paramètres de création de la fenêtre d'info-bulle.
DesignMode	Obtient une valeur qui indique si Component est actuellement en mode design. (Hérité de Component)
Events	Obtient la liste des gestionnaires d'événements attachés à ce Component. (Hérité de Component)
ForeColor	Obtient ou définit la couleur de premier plan de l'info-bulle.
InitialDelay	Obtient ou définit le temps écoulé avant l'apparition 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 le délai qui doit s'écouler avant que s'affichent des fenêtres d'info-bulle qui se suivent lorsque le pointeur de la souris passe d'un contrôle à un autre.
ShowAlways	Obtient ou définit une valeur indiquant si la fenêtre d'info-bulle apparaît même lorsque son contrôle parent n'est pas actif.
Site	Obtient ou définit le ISite de Component. (Hérité de Component)
StripAmpersands	Obtient ou définit une valeur qui détermine comment le et commercial (&) est traité.
Tag	Obtient ou définit l'objet qui contient des données fournies par le programmeur et associées au ToolTip.
ToolTipIcon	Obtient ou définit une valeur qui définit le type d'icône à afficher le long du texte d'info-bulle.
ToolTipTitle	Obtient ou définit le titre de la fenêtre d'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 d'atténuation doit être utilisé lors de l'affichage de l'info-bulle.

Méthodes

CanExtend(Object)	Retourne true si l'info-bulle peut exposer une propriété extendeur au composant cible spécifié.
CreateObjRef(Type)	Cré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)
Dispose()	Libère toutes les ressources utilisées par Component. (Hérité de Component)
Dispose(Boolean)	Libère les ressources non managées utilisées par Component et libère éventuellement les ressources managées.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
Finalize()	Libère les ressources non managées et effectue d'autres opérations de nettoyage avant que Cursor ne soit récupéré par le garbage collector.
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetLifetimeService()	Ré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)
GetService(Type)	Retourne un objet qui représente un service fourni par Component ou par son Container. (Hérité de Component)
GetToolTip(Control)	Récupère le texte d'info-bulle associé au contrôle spécifié.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
Hide(IWin32Window)	Masque la fenêtre d'info-bulle spécifiée.
InitializeLifetimeService()	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)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
MemberwiseClone(Boolean)	Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject)
RemoveAll()	Supprime tout le texte d'info-bulle actuellement associé au composant ToolTip.
SetToolTip(Control, String)	Associe un texte d'info-bulle au contrôle spécifié.
Show(String, IWin32Window)	Définit le texte d'info-bulle associé au contrôle spécifié et affiche l'info-bulle de façon modale.
Show(String, IWin32Window, Int32)	Définit le texte d'info-bulle associé au contrôle spécifié, puis affiche l'info-bulle pour la durée spécifiée.
Show(String, IWin32Window, Int32, Int32)	Définit le texte d'info-bulle associé au contrôle spécifié, puis affiche de façon modale l'info-bulle à la position relative spécifiée.
Show(String, IWin32Window, Int32, Int32, Int32)	Définit le texte d'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 d'info-bulle associé au contrôle spécifié, puis affiche de façon modale l'info-bulle à la position relative spécifiée.
Show(String, IWin32Window, Point, Int32)	Définit le texte d'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.
StopTimer()	Arrête la minuterie qui masque les info-bulles affichées.
ToString()	Retourne une représentation sous forme de chaîne pour ce contrôle.

Événements

Disposed	Se produit lorsque le composant est supprimé par un appel à la méthode Dispose(). (Hérité de Component)
Draw	Se produit lorsque l'info-bulle est dessinée et que la propriété OwnerDraw a la valeur true et la propriété IsBalloon a la valeur false.
Popup	Se produit avant l'affichage initial d'une info-bulle. Il s'agit de l'événement par défaut de la classe ToolTip.

Voir aussi

• ToolTipIcon
• HelpProvider
• Fournisseurs d'extendeurs
• ToolTip, composant (Windows Forms)