ToolTip Clase

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Source:

ToolTip.cs

Representa una ventana emergente rectangular pequeña que muestra una breve descripción de la finalidad de un control cuando el usuario descansa el puntero en el 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

Herencia

Object

MarshalByRefObject

Component

ToolTip

Implementaciones

IExtenderProvider

Ejemplos

En el ejemplo de código siguiente se crea una instancia de la ToolTip clase y se asocia la instancia a la Form que se crea la instancia. A continuación, el código inicializa las propiedades AutoPopDelayde retraso , InitialDelayy ReshowDelay. Además, la instancia de la ToolTip clase establece la ShowAlways propiedad en true para permitir que el texto de información sobre herramientas siempre se muestre independientemente de si el formulario está activo. Por último, en el ejemplo se asocia texto de información sobre herramientas con dos controles de un formulario, un Button y un CheckBox. El ejemplo de código requiere que el método definido en el ejemplo se encuentre dentro de un Form objeto que contiene un Button control denominado button1 y un CheckBox control denominado checkBox1, y que se llama al método desde el constructor de 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

Comentarios

Con la ToolTip clase , puede proporcionar sugerencias a un usuario cuando el usuario coloca el puntero en un control. La ToolTip clase se usa normalmente para alertar a los usuarios al uso previsto de un control. Por ejemplo, puede especificar texto de información sobre herramientas para un TextBox control que acepte un nombre, especificando el formato del nombre que se va a escribir en el control. Además de proporcionar sugerencias, también puede usar la ToolTip clase para proporcionar información de estado de tiempo de ejecución. Por ejemplo, puede usar la ToolTip clase para mostrar los datos de velocidad de conexión y calidad de línea cuando el usuario mueve el puntero a un PictureBox control que muestra el estado de la conexión a Internet.

La ToolTip clase se puede usar en cualquier contenedor. Para especificar explícitamente un contenedor, use el ToolTip(IContainer) constructor . Normalmente, se usa un único ToolTip componente para crear información sobre herramientas para varios controles en un único formulario. Después de crear un ToolTip, use una llamada independiente al SetToolTip método para asociar texto para mostrar información sobre herramientas a un control individual. A continuación, cuando el usuario mueve el puntero en un control, se muestra la información sobre herramientas con su texto. Puede llamar a SetToolTip más de una vez para que el mismo control cambie el texto asociado al control. Para obtener el texto asociado a un control, use el GetToolTip método . Para quitar todas las asociaciones de texto de información sobre herramientas con una instancia de la ToolTip clase , use el RemoveAll método .

Nota:

El texto de la información sobre herramientas no se muestra para los controles que están deshabilitados. A menos que la ShowAlways propiedad esté establecida trueen , la información sobre herramientas no se muestra cuando su contenedor está inactivo.

La ToolTip clase proporciona las siguientes propiedades y métodos para modificar el comportamiento predeterminado y la apariencia de una información sobre herramientas.

Categoría	Miembros asociados
Visualización manual	Active, Show, Hide, ShowAlways, , Popup, StopTimer
Tiempo de información sobre herramientas	AutoPopDelay, InitialDelay, ReshowDelay, , AutomaticDelay, StopTimer
Contenido	SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, , ToolTipTitle, RemoveAll
Aspecto	BackColor, ForeColor, IsBalloon, OwnerDraw, , UseAnimation, UseFading

Si desea deshabilitar todo el texto de información sobre herramientas para que no se pueda mostrar en la aplicación, puede usar la Active propiedad . Normalmente, el sistema operativo dibuja la información sobre herramientas, pero para personalizar la apariencia de ToolTip, puede establecer la OwnerDraw propiedad true en y controlar el Draw evento.

La ToolTipTitle clase implementa la System.ComponentModel.IExtenderProvider interfaz , que tiene un único método, CanExtend. La información sobre herramientas amplía los controles del mismo formulario en tiempo de diseño, agregando una ToolTip propiedad . Para obtener más información acerca de los proveedores extensores, vea Proveedores extensores.

Constructores

Nombre	Description
ToolTip()	Inicializa una nueva instancia de ToolTip sin un contenedor especificado.
ToolTip(IContainer)	Inicializa una nueva instancia de la ToolTip clase con un contenedor especificado.

Propiedades

Nombre	Description
Active	Obtiene o establece un valor que indica si la información sobre herramientas está activa actualmente.
AutomaticDelay	Obtiene o establece el retraso automático de la información sobre herramientas.
AutoPopDelay	Obtiene o establece el período de tiempo que la información sobre herramientas permanece visible si el puntero está estacionado en un control con texto de información sobre herramientas especificado.
BackColor	Obtiene o establece el color de fondo de la información sobre herramientas.
CreateParams	Obtiene los parámetros de creación de la ventana Información sobre herramientas.
ForeColor	Obtiene o establece el color de primer plano de la información sobre herramientas.
InitialDelay	Obtiene o establece el tiempo que pasa antes de que aparezca la información sobre herramientas.
IsBalloon	Obtiene o establece un valor que indica si la información sobre herramientas debe usar una ventana de globo.
OwnerDraw	Obtiene o establece un valor que indica si el sistema operativo dibuja la información sobre herramientas o por código que proporcione.
ReshowDelay	Obtiene o establece el período de tiempo que debe transpirar antes de que aparezcan las ventanas de información sobre herramientas posteriores a medida que el puntero se mueve de un control a otro.
ShowAlways	Obtiene o establece un valor que indica si se muestra una ventana de información sobre herramientas, incluso cuando su control primario no está activo.
StripAmpersands	Obtiene o establece un valor que determina cómo se tratan los caracteres y los caracteres (&).
Tag	Obtiene o establece el objeto que contiene los datos proporcionados por el programador asociados a ToolTip.
ToolTipIcon	Obtiene o establece un valor que define el tipo de icono que se va a mostrar junto con el texto de información sobre herramientas.
ToolTipTitle	Obtiene o establece un título para la ventana Información sobre herramientas.
UseAnimation	Obtiene o establece un valor que determina si se debe usar un efecto de animación al mostrar la información sobre herramientas.
UseFading	Obtiene o establece un valor que determina si se debe usar un efecto de atenuación al mostrar la información sobre herramientas.

Métodos

Nombre	Description
CanExtend(Object)	Devuelve true si la información sobre herramientas puede ofrecer una propiedad extender al componente de destino especificado.
Dispose(Boolean)	Libera los recursos no administrados utilizados por Component y, opcionalmente, libera los recursos administrados.
Finalize()	Libera los recursos no administrados y realiza otras operaciones de limpieza antes Cursor de que el recolector de elementos no utilizados lo recupere.
GetToolTip(Control)	Recupera el texto de información sobre herramientas asociado al control especificado.
Hide(IWin32Window)	Oculta la ventana de información sobre herramientas especificada.
RemoveAll()	Quita todo el texto de información sobre herramientas asociado actualmente al componente ToolTip.
SetToolTip(Control, String)	Asocia texto de información sobre herramientas al control especificado.
Show(String, IWin32Window, Int32, Int32, Int32)	Establece el texto de información sobre herramientas asociado al control especificado y, a continuación, muestra la información sobre herramientas durante la duración especificada en la posición relativa especificada.
Show(String, IWin32Window, Int32, Int32)	Establece el texto de información sobre herramientas asociado al control especificado y, a continuación, muestra la información sobre herramientas en la posición relativa especificada.
Show(String, IWin32Window, Int32)	Establece el texto de información sobre herramientas asociado al control especificado y, a continuación, muestra la información sobre herramientas durante la duración especificada.
Show(String, IWin32Window, Point, Int32)	Establece el texto de información sobre herramientas asociado al control especificado y, a continuación, muestra la información sobre herramientas durante la duración especificada en la posición relativa especificada.
Show(String, IWin32Window, Point)	Establece el texto de información sobre herramientas asociado al control especificado y, a continuación, muestra la información sobre herramientas en la posición relativa especificada.
Show(String, IWin32Window)	Establece el texto de información sobre herramientas asociado al control especificado y muestra la información sobre herramientas de forma modal.
StopTimer()	Detiene el temporizador que oculta la información sobre herramientas mostrada.
ToString()	Devuelve una representación de cadena para este control.

Eventos

Nombre	Description
Draw	Se produce cuando se dibuja la información sobre herramientas y la OwnerDraw propiedad se establece true en y la IsBalloon propiedad es false.
Popup	Se produce antes de que se muestre inicialmente una información sobre herramientas. Este es el evento predeterminado para la ToolTip clase .

Consulte también

• ToolTipIcon
• HelpProvider
• Proveedores extensores
• Componente ToolTip (Formularios Windows Forms)