ToolTip ToolTip ToolTip ToolTip Class

Definición

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.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
Herencia
Implementaciones

Ejemplos

En el ejemplo de código siguiente se crea una instancia de la ToolTip clase y la asocia con el Form que se creó la instancia.The following code example creates an instance of the ToolTip class and associates the instance with the Form that the instance is created within. El código, a continuación, inicializa las propiedades de retraso AutoPopDelay, InitialDelay, y ReshowDelay.The code then initializes the delay properties AutoPopDelay, InitialDelay, and ReshowDelay. Además la instancia de la ToolTip clase conjuntos el ShowAlways propiedad true para habilitar el texto de información sobre herramientas siempre se muestre independientemente de si el formulario está activo.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. Por último, en el ejemplo se asocia el texto de información sobre herramientas a dos controles en un formulario, un Button y un CheckBox.Finally, the example associates ToolTip text with two controls on a form, a Button and a CheckBox. El ejemplo de código requiere que el método definido en el ejemplo se encuentra en un Form que contiene un Button control denominado button1 y un CheckBox control denominado checkBox1, y que se llama al método desde el constructor de la Form.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

Comentarios

Con el ToolTip (clase), puede proporcionar sugerencias a un usuario cuando el usuario coloca el puntero sobre un control.With the ToolTip class, you can provide hints to a user when the user places the pointer on a control. La ToolTip clase se utiliza normalmente para avisar a los usuarios para el uso previsto de un control.The ToolTip class is typically used to alert users to the intended use of a control. Por ejemplo, puede especificar texto de información sobre un TextBox control que acepta un nombre, que especifica el formato del nombre que debe escribirse en el 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. Además de ofrecer sugerencias, también puede usar el ToolTip clase para proporcionar información de estado de tiempo de ejecución.In addition to providing hints, you can also use the ToolTip class to provide run time status information. Por ejemplo, puede usar el ToolTip clase para mostrar los datos de calidad de velocidad y la línea de conexión cuando el usuario mueve el puntero sobre un PictureBox control que muestra el estado de conexión de Internet.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.

La ToolTip clase puede usarse en cualquier contenedor.The ToolTip class can be used in any container. Para especificar explícitamente un contenedor, use el ToolTip(IContainer) constructor.To explicitly specify a container, use the ToolTip(IContainer) constructor. Una sola ToolTip componente se utiliza normalmente para crear información sobre herramientas para varios controles en un único formulario.A single ToolTip component typically is used to create ToolTips for multiple controls on a single form. Después de crear un ToolTip, use una llamada independiente a la SetToolTip para asociar el texto para mostrar información sobre herramientas a un control individual.After you create a ToolTip, use a separate call to the SetToolTip method to associate ToolTip display text to an individual control. A continuación, cuando el usuario mueve el puntero sobre un control, se muestra la información sobre herramientas con su texto.Then when the user moves the pointer on a control, the ToolTip with its text is displayed. Puede llamar a SetToolTip más de una vez para el mismo control cambiar el texto que está asociado con el control.You can call SetToolTip more than once for the same control to change the text that is associated with the control. Para obtener el texto que está asociado a un control, use el GetToolTip método.To get the text that is associated with a control, use the GetToolTip method. Para quitar todas las asociaciones de texto de información sobre herramientas con una instancia de la ToolTip clase, use el RemoveAll método.To remove all ToolTip text associations with an instance of the ToolTip class, use the RemoveAll method.

Nota

No se muestra el texto de información sobre herramientas para los controles que están deshabilitados.ToolTip text is not displayed for controls that are disabled. A menos que el ShowAlways propiedad está establecida en true, no se muestra información sobre herramientas cuando su contenedor está inactivo.Unless the ShowAlways property is set to true, ToolTips are not displayed when their container is inactive.

La ToolTip clase proporciona las siguientes propiedades y métodos para modificar el comportamiento predeterminado y la apariencia de una información sobre herramientas.The ToolTip class provides the following properties and methods to modify the default behavior and appearance of a ToolTip.

CategoríaCategory Miembros asociadosAssociated members
Presentación manualManual display Active, Show, Hide, ShowAlways, Popup, StopTimerActive, Show, Hide, ShowAlways, Popup, StopTimer
Tiempo de la información sobre herramientasToolTip timing AutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimerAutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimer
ContenidoContent SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAllSetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAll
AparienciaAppearance BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFadingBackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFading

Si desea deshabilitar todo el texto de información sobre herramientas para que no se puede mostrar en la aplicación, puede usar el Active propiedad.If you want to disable all ToolTip text so that it cannot be displayed in your application, you can use the Active property. Normalmente, la información sobre herramientas se dibuja el sistema operativo, pero para personalizar la apariencia de la ToolTip, puede establecer el OwnerDraw propiedad a true y controlar el Draw eventos.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.

El ToolTipTitle la clase implementa la System.ComponentModel.IExtenderProvider interfaz, que tiene un único método, CanExtend.The ToolTipTitle class implements the System.ComponentModel.IExtenderProvider interface, which has a single method, CanExtend. Información sobre herramientas ampliar los controles en el mismo formulario en tiempo de diseño, agregar un ToolTip propiedad.ToolTips extend controls on the same form at design time, adding a ToolTip property. Para obtener más información sobre proveedores extensores, vea proveedores extensores.For more information about extender providers, see Extender Providers.

Constructores

ToolTip() ToolTip() ToolTip() ToolTip()

Inicializa una nueva instancia de ToolTip sin un contenedor especificado.Initializes a new instance of the ToolTip without a specified container.

ToolTip(IContainer) ToolTip(IContainer) ToolTip(IContainer) ToolTip(IContainer)

Inicializa una nueva instancia de la clase ToolTip con un contenedor especificado.Initializes a new instance of the ToolTip class with a specified container.

Propiedades

Active Active Active Active

Obtiene o establece un valor que indica si la información sobre herramientas está actualmente activa.Gets or sets a value indicating whether the ToolTip is currently active.

AutomaticDelay AutomaticDelay AutomaticDelay AutomaticDelay

Obtiene o establece el retraso automático de la información sobre herramientas.Gets or sets the automatic delay for the ToolTip.

AutoPopDelay AutoPopDelay AutoPopDelay 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 que tenga el texto de información sobre herramientas especificado.Gets or sets the period of time the ToolTip remains visible if the pointer is stationary on a control with specified ToolTip text.

BackColor BackColor BackColor BackColor

Obtiene o establece el color de fondo de la información sobre herramientas.Gets or sets the background color for the ToolTip.

CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Obtiene un valor que indica si el componente puede generar un evento.Gets a value indicating whether the component can raise an event.

(Inherited from Component)
Container Container Container Container

Obtiene IContainer que contiene Component.Gets the IContainer that contains the Component.

(Inherited from Component)
CreateParams CreateParams CreateParams CreateParams

Obtiene los parámetros de creación para la ventana de información sobre herramientas.Gets the creation parameters for the ToolTip window.

DesignMode DesignMode DesignMode DesignMode

Obtiene un valor que indica si Component está actualmente en modo de diseño.Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
Events Events Events Events

Obtiene la lista de controladores de eventos asociados a Component.Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
ForeColor ForeColor ForeColor ForeColor

Obtiene o establece el color de primer plano de la información sobre herramientas.Gets or sets the foreground color for the ToolTip.

InitialDelay InitialDelay InitialDelay InitialDelay

Obtiene o establece el tiempo que transcurre hasta que aparece la información sobre herramientas.Gets or sets the time that passes before the ToolTip appears.

IsBalloon IsBalloon IsBalloon IsBalloon

Obtiene o establece un valor que indica si la información sobre herramientas debería utilizar una ventana de globo.Gets or sets a value indicating whether the ToolTip should use a balloon window.

OwnerDraw OwnerDraw OwnerDraw 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.Gets or sets a value indicating whether the ToolTip is drawn by the operating system or by code that you provide.

ReshowDelay ReshowDelay ReshowDelay 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.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 ShowAlways ShowAlways 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.Gets or sets a value indicating whether a ToolTip window is displayed, even when its parent control is not active.

Site Site Site Site

Obtiene o establece el ISite de Component.Gets or sets the ISite of the Component.

(Inherited from Component)
StripAmpersands StripAmpersands StripAmpersands StripAmpersands

Obtiene o establece un valor que determina cómo se tratan los caracteres de "y comercial" (&).Gets or sets a value that determines how ampersand (&) characters are treated.

Tag Tag Tag Tag

Obtiene o establece el objeto que contiene los datos proporcionados por el programador asociados a ToolTip.Gets or sets the object that contains programmer-supplied data associated with the ToolTip.

ToolTipIcon ToolTipIcon ToolTipIcon 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.Gets or sets a value that defines the type of icon to be displayed alongside the ToolTip text.

ToolTipTitle ToolTipTitle ToolTipTitle ToolTipTitle

Obtiene o establece un título para la ventana de información sobre herramientas.Gets or sets a title for the ToolTip window.

UseAnimation UseAnimation UseAnimation 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.Gets or sets a value determining whether an animation effect should be used when displaying the ToolTip.

UseFading UseFading UseFading 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.Gets or sets a value determining whether a fade effect should be used when displaying the ToolTip.

Métodos

CanExtend(Object) CanExtend(Object) CanExtend(Object) CanExtend(Object)

Devuelve true si la información sobre herramientas puede ofrecer una propiedad extensora al componente de destino especificado.Returns true if the ToolTip can offer an extender property to the specified target component.

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto.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() Dispose() Dispose() Dispose()

Libera todos los recursos que usa Component.Releases all resources used by the Component.

(Inherited from Component)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Libera los recursos no administrados que usa Component y, de forma opcional, libera los recursos administrados.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Finalize() Finalize() Finalize() Finalize()

Libera los recursos no administrados y realiza otras operaciones de limpieza antes de que el recolector de elementos no utilizados reclame Cursor.Releases the unmanaged resources and performs other cleanup operations before the Cursor is reclaimed by the garbage collector.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetService(Type) GetService(Type) GetService(Type) GetService(Type)

Devuelve un objeto que representa el servicio suministrado por Component o por Container.Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetToolTip(Control) GetToolTip(Control) GetToolTip(Control) GetToolTip(Control)

Recupera el texto de información sobre herramientas asociado al control especificado.Retrieves the ToolTip text associated with the specified control.

GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
Hide(IWin32Window) Hide(IWin32Window) Hide(IWin32Window) Hide(IWin32Window)

Oculta la ventana de información sobre herramientas especificada.Hides the specified ToolTip window.

InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Crea una copia superficial del objeto MarshalByRefObject actual.Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
RemoveAll() RemoveAll() RemoveAll() RemoveAll()

Quita todo el texto de información de herramientas asociado al componente de información sobre herramientas.Removes all ToolTip text currently associated with the ToolTip component.

SetToolTip(Control, String) SetToolTip(Control, String) SetToolTip(Control, String) SetToolTip(Control, String)

Asocia el texto de información sobre herramientas al control especificado.Associates ToolTip text with the specified control.

Show(String, IWin32Window) Show(String, IWin32Window) Show(String, IWin32Window) Show(String, IWin32Window)

Establece el texto de información sobre herramientas asociado al control especificado y muestra de forma modal la información sobre herramientas.Sets the ToolTip text associated with the specified control, and displays the ToolTip modally.

Show(String, IWin32Window, Int32) Show(String, IWin32Window, Int32) Show(String, IWin32Window, Int32) 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 para la duración especificada.Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration.

Show(String, IWin32Window, Int32, Int32) Show(String, IWin32Window, Int32, Int32) Show(String, IWin32Window, Int32, Int32) 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 sobre herramientas en la posición relativa especificada.Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position.

Show(String, IWin32Window, Int32, Int32, Int32) Show(String, IWin32Window, Int32, Int32, Int32) Show(String, IWin32Window, Int32, Int32, Int32) 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 para la duración especificada en la posición relativa indicada.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) Show(String, IWin32Window, Point) Show(String, IWin32Window, Point) 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 sobre herramientas en la posición relativa especificada.Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position.

Show(String, IWin32Window, Point, Int32) Show(String, IWin32Window, Point, Int32) Show(String, IWin32Window, Point, Int32) 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 para la duración especificada en la posición relativa indicada.Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position.

StopTimer() StopTimer() StopTimer() StopTimer()

Detiene el temporizador que oculta la información sobre herramientas mostrada.Stops the timer that hides displayed ToolTips.

ToString() ToString() ToString() ToString()

Devuelve una representación de cadena para este control.Returns a string representation for this control.

Eventos

Disposed Disposed Disposed Disposed

Se produce cuando el componente se elimina mediante una llamada al método Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)
Draw Draw Draw 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.Occurs when the ToolTip is drawn and the OwnerDraw property is set to true and the IsBalloon property is false.

Popup Popup Popup Popup

Sucede antes de que se muestre una información sobre herramientas inicialmente.Occurs before a ToolTip is initially displayed. Éste es el evento predeterminado para la clase ToolTip.This is the default event for the ToolTip class.

Se aplica a

Consulte también: