ToolTip Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ToolTip.cs

Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.

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

Inheritance

Object

MarshalByRefObject

Component

ToolTip

Implements

IExtenderProvider

Examples

The following code example creates an instance of the ToolTip class and associates the instance with the Form that the instance is created within. The code then initializes the delay properties AutoPopDelay, InitialDelay, and ReshowDelay. In addition the instance of the ToolTip class sets the ShowAlways property to true to enable ToolTip text to always be display regardless of whether the form is active. Finally, the example associates ToolTip text with two controls on a form, a Button and a CheckBox. The code example requires that the method defined in the example is located within a Form that contains a Button control named button1 and a CheckBox control named checkBox1, and that the method is called from the constructor of the 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

Remarks

With the ToolTip class, you can provide hints to a user when the user places the pointer on a control. The ToolTip class is typically used to alert users to the intended use of a control. For example, you can specify ToolTip text for a TextBox control that accepts a name, specifying the format of the name to be typed into the control. In addition to providing hints, you can also use the ToolTip class to provide run time status information. For example, you can use the ToolTip class to display connection speed and line quality data when the user moves the pointer onto a PictureBox control that displays Internet connection status.

The ToolTip class can be used in any container. To explicitly specify a container, use the ToolTip(IContainer) constructor. A single ToolTip component typically is used to create ToolTips for multiple controls on a single form. After you create a ToolTip, use a separate call to the SetToolTip method to associate ToolTip display text to an individual control. Then when the user moves the pointer on a control, the ToolTip with its text is displayed. You can call SetToolTip more than once for the same control to change the text that is associated with the control. To get the text that is associated with a control, use the GetToolTip method. To remove all ToolTip text associations with an instance of the ToolTip class, use the RemoveAll method.

Note

ToolTip text is not displayed for controls that are disabled. Unless the ShowAlways property is set to true, ToolTips are not displayed when their container is inactive.

The ToolTip class provides the following properties and methods to modify the default behavior and appearance of a ToolTip.

Category	Associated members
Manual display	Active, Show, Hide, ShowAlways, Popup, StopTimer
ToolTip timing	AutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimer
Content	SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAll
Appearance	BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFading

If you want to disable all ToolTip text so that it cannot be displayed in your application, you can use the Active property. Usually the ToolTip is drawn by the operating system, but to customize the appearance of the ToolTip, you can set the OwnerDraw property to true and handle the Draw event.

The ToolTipTitle class implements the System.ComponentModel.IExtenderProvider interface, which has a single method, CanExtend. ToolTips extend controls on the same form at design time, adding a ToolTip property. For more information about extender providers, see Extender Providers.

Constructors

ToolTip()	Initializes a new instance of the ToolTip without a specified container.
ToolTip(IContainer)	Initializes a new instance of the ToolTip class with a specified container.

Properties

Active	Gets or sets a value indicating whether the ToolTip is currently active.
AutomaticDelay	Gets or sets the automatic delay for the ToolTip.
AutoPopDelay	Gets or sets the period of time the ToolTip remains visible if the pointer is stationary on a control with specified ToolTip text.
BackColor	Gets or sets the background color for the ToolTip.
CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
Container	Gets the IContainer that contains the Component. (Inherited from Component)
CreateParams	Gets the creation parameters for the ToolTip window.
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
ForeColor	Gets or sets the foreground color for the ToolTip.
InitialDelay	Gets or sets the time that passes before the ToolTip appears.
IsBalloon	Gets or sets a value indicating whether the ToolTip should use a balloon window.
OwnerDraw	Gets or sets a value indicating whether the ToolTip is drawn by the operating system or by code that you provide.
ReshowDelay	Gets or sets the length of time that must transpire before subsequent ToolTip windows appear as the pointer moves from one control to another.
ShowAlways	Gets or sets a value indicating whether a ToolTip window is displayed, even when its parent control is not active.
Site	Gets or sets the ISite of the Component. (Inherited from Component)
StripAmpersands	Gets or sets a value that determines how ampersand (&) characters are treated.
Tag	Gets or sets the object that contains programmer-supplied data associated with the ToolTip.
ToolTipIcon	Gets or sets a value that defines the type of icon to be displayed alongside the ToolTip text.
ToolTipTitle	Gets or sets a title for the ToolTip window.
UseAnimation	Gets or sets a value determining whether an animation effect should be used when displaying the ToolTip.
UseFading	Gets or sets a value determining whether a fade effect should be used when displaying the ToolTip.

Methods

CanExtend(Object)	Returns true if the ToolTip can offer an extender property to the specified target component.
CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
Dispose()	Releases all resources used by the Component. (Inherited from Component)
Dispose(Boolean)	Releases the unmanaged resources used by the Component and optionally releases the managed resources.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize()	Releases the unmanaged resources and performs other cleanup operations before the Cursor is reclaimed by the garbage collector.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetService(Type)	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
GetToolTip(Control)	Retrieves the ToolTip text associated with the specified control.
GetType()	Gets the Type of the current instance. (Inherited from Object)
Hide(IWin32Window)	Hides the specified ToolTip window.
InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
RemoveAll()	Removes all ToolTip text currently associated with the ToolTip component.
SetToolTip(Control, String)	Associates ToolTip text with the specified control.
Show(String, IWin32Window, Int32, Int32, Int32)	Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position.
Show(String, IWin32Window, Int32, Int32)	Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position.
Show(String, IWin32Window, Int32)	Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration.
Show(String, IWin32Window, Point, Int32)	Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position.
Show(String, IWin32Window, Point)	Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position.
Show(String, IWin32Window)	Sets the ToolTip text associated with the specified control, and displays the ToolTip modally.
StopTimer()	Stops the timer that hides displayed ToolTips.
ToString()	Returns a string representation for this control.

Events

Disposed	Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component)
Draw	Occurs when the ToolTip is drawn and the OwnerDraw property is set to true and the IsBalloon property is false.
Popup	Occurs before a ToolTip is initially displayed. This is the default event for the ToolTip class.

See also

• ToolTipIcon
• HelpProvider
• Extender Providers
• ToolTip Component (Windows Forms)