ToolTip-Klasse
Stellt ein kleines rechteckiges Popupfenster dar, das eine kurze Beschreibung des Zwecks eines Steuerelements anzeigt, wenn sich der Zeiger auf dem Steuerelement befindet.
Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)
Syntax
'Declaration
Public Class ToolTip
Inherits Component
Implements IExtenderProvider
'Usage
Dim instance As ToolTip
public class ToolTip : Component, IExtenderProvider
public ref class ToolTip : public Component, IExtenderProvider
public class ToolTip extends Component implements IExtenderProvider
public class ToolTip extends Component implements IExtenderProvider
Hinweise
Mit der ToolTip-Klasse können Sie Hinweise für einen Benutzer bereitstellen, wenn der Benutzer den Zeiger auf einem Steuerelement platziert. Die ToolTip-Klasse wird i. d. R. verwendet, um Benutzer auf die für ein Steuerelement vorgesehene Verwendung aufmerksam zu machen. Sie können z. B. einen QuickInfo-Text für ein TextBox-Steuerelement angeben, das einen Namen annimmt, indem Sie das Format des in das Steuerelement einzugebenden Namens angeben. Neben dem Bereitstellen von Hinweisen können Sie die ToolTip-Klasse zum Bereitstellen von Statusinformationen zur Laufzeit verwenden. Sie können die ToolTip-Klasse z. B. verwenden, um Daten zu Verbindungsgeschwindigkeit und -eigenschaften anzeigen zu lassen, wenn der Benutzer den Zeiger über ein PictureBox-Steuerelement bewegt, das den Status einer Internetverbindung anzeigt.
Die ToolTip-Klasse kann in jedem Container verwendet werden. Wenn Sie einen Container explizit angeben möchten, verwenden Sie den ToolTip(IContainer)-Konstruktor. Eine einzelne ToolTip-Komponente wird normalerweise verwendet, um QuickInfos für mehrere Steuerelemente auf einem einzelnen Formular zu erstellen. Wenn Sie einen ToolTip erstellt haben, ordnen Sie den QuickInfo-Anzeigetext durch einen gesonderten Aufruf der SetToolTip-Methode einem einzelnen Steuerelement zu. Wenn der Benutzer den Zeiger auf ein Steuerelement bewegt, wird die QuickInfo mit dem Text angezeigt. Sie können SetToolTip mehrmals für das gleiche Steuerelement aufrufen, um den Text zu ändern, der dem Steuerelement zugeordnet ist. Wenn Sie den einem Steuerelement zugeordneten Text abrufen möchten, verwenden Sie die GetToolTip-Methode. Verwenden Sie die RemoveAll-Methode, um sämtliche Zuordnungen von QuickInfo-Text zu einer Instanz der ToolTip-Klasse zu entfernen.
Hinweis
Für deaktivierte Steuerelemente wird kein QuickInfo-Text angezeigt. Wenn der QuickInfos-Container inaktiv ist, werden diese nur angezeigt, wenn die ShowAlways-Eigenschaft auf true festgelegt ist.
Die ToolTip-Klasse stellt die folgenden Eigenschaften und Methoden bereit, um das Standardverhalten und die Standarddarstellung einer QuickInfo zu ändern:
Kategorie |
Zugeordnete Member |
|---|---|
Manuelle Anzeige |
|
Zeitliche Steuerung der QuickInfo |
AutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimer |
Inhalt |
SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAll |
Darstellung |
BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFading |
Wenn Sie alle QuickInfo-Texte deaktivieren möchten, sodass diese in der Anwendung nicht angezeigt werden, können Sie die Active-Eigenschaft verwenden. Normalerweise wird die QuickInfo vom Betriebssystem gezeichnet. Um die Darstellung des ToolTip anzupassen, können Sie jedoch die OwnerDraw-Eigenschaft auf true festlegen und das Draw-Ereignis behandeln.
Die ToolTipTitle-Klasse implementiert die System.ComponentModel.IExtenderProvider-Schnittstelle, die über eine einzelne Methode, CanExtend, verfügt. QuickInfos erweitern Steuerelemente zur Entwurfszeit auf dem gleichen Formular, indem sie eine ToolTip-Eigenschaft hinzufügen. Weitere Informationen über Extenderanbieter finden Sie unter Extenderanbieter.
Beispiel
Im folgenden Codebeispiel wird eine Instanz der ToolTip-Klasse erstellt und dem Form zugeordnet, in dem sie erstellt wurde. Der Code initialisiert anschließend die Verzögerungseigenschaften AutoPopDelay, InitialDelay und ReshowDelay. Außerdem legt die Instanz der ToolTip-Klasse die ShowAlways-Eigenschaft auf true fest, damit QuickInfo-Text auch angezeigt werden kann, wenn das Formular nicht aktiv ist. Am Schluss des Beispiels wird der QuickInfo-Text zwei Steuerelementen in einem Formular zugeordnet, einem Button und einer CheckBox. Für dieses Beispiel muss sich die im Beispiel definierte Methode in einem Form befinden, das das Button-Steuerelement button1 und das CheckBox-Steuerelement checkBox1 enthält; außerdem muss die Methode über den Konstruktor von Form aufgerufen werden.
' 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
// 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.
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.set_AutoPopDelay(5000);
toolTip1.set_InitialDelay(1000);
toolTip1.set_ReshowDelay(500);
// Force the ToolTip text to be displayed whether or not the form
// is active.
toolTip1.set_ShowAlways(true);
// Set up the ToolTip text for the Button and Checkbox.
toolTip1.SetToolTip(this.button1, "My button1");
toolTip1.SetToolTip(this.checkBox1, "My checkBox1");
} //Form1_Load
Vererbungshierarchie
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Windows.Forms.ToolTip
Threadsicherheit
Alle öffentlichen statischen (Shared in Visual Basic) Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.
Plattformen
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.
Versionsinformationen
.NET Framework
Unterstützt in: 2.0, 1.1, 1.0
Siehe auch
Referenz
ToolTip-Member
System.Windows.Forms-Namespace
ToolTipIcon
HelpProvider-Klasse