ToolTip Clase

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Representa una pequeña ventana emergente rectangular que muestra una breve descripción de la finalidad de un control cuando el usuario sitúa el puntero sobre 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 la 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 a dos controles de un formulario, a Button y a 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 en tiempo de ejecución. Por ejemplo, puede usar la ToolTip clase para mostrar datos de calidad de línea y velocidad de conexión 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, un único ToolTip componente se usa 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 SetToolTip a 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.

Category	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 extiende los controles en el mismo formulario en tiempo de diseño y agrega una ToolTip propiedad . Para obtener más información sobre los proveedores extensores, vea Proveedores extensores.

Constructores

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

Propiedades

Active	Obtiene o establece un valor que indica si la información sobre herramientas está actualmente activa.
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 estará visible si el puntero se detiene sobre un control para el que se haya especificado esa información.
BackColor	Obtiene o establece el color de fondo de la información sobre herramientas.
CanRaiseEvents	Obtiene un valor que indica si el componente puede generar un evento. (Heredado de Component)
Container	Obtiene la interfaz IContainer que contiene la clase Component. (Heredado de Component)
CreateParams	Obtiene los parámetros de creación para la ventana de información sobre herramientas.
DesignMode	Obtiene un valor que indica si Component está actualmente en modo de diseño. (Heredado de Component)
Events	Obtiene la lista de controladores de eventos asociados a Component. (Heredado de Component)
ForeColor	Obtiene o establece el color de primer plano de la información sobre herramientas.
InitialDelay	Obtiene o establece el tiempo que transcurre hasta que aparece la información sobre herramientas.
IsBalloon	Obtiene o establece un valor que indica si la información sobre herramientas debería utilizar una ventana de globo.
OwnerDraw	Obtiene o establece un valor que indica si la información sobre herramientas la dibuja el sistema operativo o el código que se proporciona.
ReshowDelay	Obtiene o establece el período de tiempo que debe transcurrir antes de que aparezca la siguiente ventana de información sobre herramientas cuando el puntero se desplaza de un control a otro.
ShowAlways	Obtiene o establece un valor que indica si la ventana de información sobre herramientas se muestra aunque el control primario no esté activo.
Site	Obtiene o establece ISite de Component. (Heredado de Component)
StripAmpersands	Obtiene o establece un valor que determina cómo se tratan los caracteres de "y" comercial (&).
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 al texto de información sobre herramientas.
ToolTipTitle	Obtiene o establece un título para la ventana de información sobre herramientas.
UseAnimation	Obtiene o establece un valor que determina si se debería utilizar un efecto de animación al mostrar la información sobre herramientas.
UseFading	Obtiene o establece un valor que determina si se debería utilizar un efecto de atenuación al mostrar la información sobre herramientas.

Métodos

CanExtend(Object)	Devuelve true si la información sobre herramientas puede ofrecer una propiedad extensora al componente de destino especificado.
CreateObjRef(Type)	Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto. (Heredado de MarshalByRefObject)
Dispose()	Libera todos los recursos que usa Component. (Heredado de Component)
Dispose(Boolean)	Libera los recursos no administrados que usa Component y, de forma opcional, libera los recursos administrados.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
Finalize()	Libera los recursos no administrados y realiza otras operaciones de limpieza antes de que el recolector de elementos no utilizados reclame Cursor.
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetLifetimeService()	Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia. (Heredado de MarshalByRefObject)
GetService(Type)	Devuelve un objeto que representa el servicio suministrado por Component o por Container. (Heredado de Component)
GetToolTip(Control)	Recupera el texto de información sobre herramientas asociado al control especificado.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
Hide(IWin32Window)	Oculta la ventana de información sobre herramientas especificada.
InitializeLifetimeService()	Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia. (Heredado de MarshalByRefObject)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
MemberwiseClone(Boolean)	Crea una copia superficial del objeto MarshalByRefObject actual. (Heredado de MarshalByRefObject)
RemoveAll()	Quita todo el texto de información de herramientas asociado al componente de información sobre herramientas.
SetToolTip(Control, String)	Asocia el texto de información sobre herramientas al control especificado.
Show(String, IWin32Window)	Establece el texto de información sobre herramientas asociado al control especificado y muestra de forma modal esa información.
Show(String, IWin32Window, Int32)	Establece el texto de información sobre herramientas asociado al control especificado y, a continuación, muestra la información durante el tiempo especificado.
Show(String, IWin32Window, Int32, Int32)	Establece el texto de información sobre herramientas asociado al control especificado y, a continuación, muestra de forma modal la información en la posición relativa especificada.
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 durante el tiempo especificado en la posición relativa indicada.
Show(String, IWin32Window, Point)	Establece el texto de información sobre herramientas asociado al control especificado y, a continuación, muestra de forma modal la información en la posición relativa 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 durante el tiempo especificado en la posición relativa indicada.
StopTimer()	Detiene el temporizador que oculta la información sobre herramientas mostrada.
ToString()	Devuelve una representación de cadena para este control.

Eventos

Disposed	Tiene lugar cuando una llamada elimina el componente mediante una llamada al método Dispose(). (Heredado de Component)
Draw	Se produce cuando se dibuja la información sobre herramientas, la propiedad OwnerDraw se establece en true y el valor de la propiedad IsBalloon es false.
Popup	Sucede antes de que se muestre inicialmente una información sobre herramientas. Éste es el evento predeterminado para la clase ToolTip.

Consulte también

• ToolTipIcon
• HelpProvider
• Proveedores extensores
• ToolTip (Componente, formularios Windows Forms)