ToolTip (Clase) (System.Windows.Forms)

Cambiar vista:
Sin script
Biblioteca de clases de .NET Framework
ToolTip (Clase)

Actualización: noviembre 2007

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.

Espacio de nombres:  System.Windows.Forms
Ensamblado:  System.Windows.Forms (en System.Windows.Forms.dll)
Sintaxis

Visual Basic (Declaración)
Public Class ToolTip _
	Inherits Component _
	Implements IExtenderProvider
Visual Basic (Uso)
Dim instance As ToolTip
C#
public class ToolTip : Component, IExtenderProvider
Visual C++
public ref class ToolTip : public Component, 
	IExtenderProvider
J#
public class ToolTip extends Component implements IExtenderProvider
JScript
public class ToolTip extends Component implements IExtenderProvider
Comentarios

Con la clase ToolTip, puede proporcionar sugerencias a un usuario cuando éste coloca el puntero sobre un control. Normalmente, la clase ToolTip se utiliza para notificar a los usuarios el uso al que está destinado un control. Por ejemplo, para un control TextBox que acepta un nombre, podría especificar un texto de información sobre herramientas que indique el formato del nombre que se debe escribir en el control. Además de para proporcionar sugerencias, la clase ToolTip se puede utilizar para proporcionar información de estado en tiempo de ejecución. Por ejemplo, se puede utilizar la clase ToolTip para mostrar datos sobre la velocidad de conexión y la calidad de la línea cuando el usuario desplace el puntero sobre un control PictureBox que muestra el estado de la conexión a Internet.

La clase ToolTip se puede utilizar en cualquier contenedor. Para especificar explícitamente un contenedor, utilice el constructor ToolTip(IContainer). Un componente ToolTip único se utiliza normalmente para crear información sobre herramientas para diversos controles en un formulario único. Después de crear ToolTip, utilice una llamada independiente al método SetToolTip para asociar el texto de presentación de información sobre herramientas a un control individual. A continuación, cuando el usuario mueve el puntero sobre un control, se muestra la información sobre herramientas con su texto. Puede llamar a SetToolTip más de una vez para el mismo control para cambiar el texto que se asocia al control. Para obtener el texto al que está asociado un control, utilice el método GetToolTip. Para quitar todos los textos de información sobre herramientas asociados a una instancia de la clase ToolTip, utilice el método RemoveAll.

ecft989x.alert_note(es-es,VS.90).gif Nota:

La información sobre herramientas no se muestra para los controles que están deshabilitados. A menos que la propiedad ShowAlways se establezca en true, no se muestra la información sobre herramientas cuando su contenedor está inactivo.

La clase ToolTip proporciona las propiedades y los métodos siguientes para modificar el comportamiento y aspecto predeterminados de una información sobre herramientas.

Categoría

Miembros asociados

Presentación manual

Active , Show, Hide, ShowAlways, Popup, StopTimer

Control de 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 que no se muestre ningún texto de información sobre herramientas en la aplicación, utilice la propiedad Active. Generalmente, la información sobre herramientas la dibuja el sistema operativo, pero para personalizar la apariencia de ToolTip, puede establecer la propiedad OwnerDraw en true y controlar el evento Draw.

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

Ejemplos

En el siguiente ejemplo de código se crea una instancia de la clase ToolTip y la asocia a Form donde se creó la instancia. Después, el código inicializa las propiedades de retraso AutoPopDelay, InitialDelay y ReshowDelay. Además, la instancia de la clase ToolTip establece la propiedad ShowAlways en true para que el texto de información sobre herramientas se muestre siempre, aunque el formulario no esté activo. Por último, en el ejemplo se asocia el texto de información sobre herramientas a dos controles de un formulario, Button y CheckBox. El ejemplo de código requiere que el método definido en él se encuentre en un Form que contenga un control Button denominado button1 y un control CheckBox denominado checkBox1 y que se llame al método desde el constructor de Form.

Visual Basic
' 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


C#
      // 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");
      }


Visual C++
// 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" );
}


J#
// 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


Jerarquía de herencia

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.ToolTip
Seguridad para subprocesos

Todos los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.
Plataformas

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

.NET Framework y .NET Compact Framework no admiten todas las versiones de cada plataforma. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.
Información de versión

.NET Framework

Compatible con: 3.5, 3.0, 2.0, 1.1, 1.0
Vea también

Referencia

Otros recursos