ToolTip ToolTip ToolTip ToolTip Class

Definição

Representa uma pequena janela pop-up retangular que exibe uma breve descrição da finalidade do controle quando o usuário deixa o ponteiro sobre o controle.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
Herança
Implementações

Exemplos

O exemplo de código a seguir cria uma instância ToolTip da classe e associa a instância ao Form na qual a instância é criada.The following code example creates an instance of the ToolTip class and associates the instance with the Form that the instance is created within. Em seguida, o código inicializa as AutoPopDelaypropriedades InitialDelayde atraso ReshowDelay, e.The code then initializes the delay properties AutoPopDelay, InitialDelay, and ReshowDelay. Além disso, a instância da ToolTip classe define a ShowAlways Propriedade como true para habilitar o texto da dica de ferramenta para sempre ser exibido, independentemente de o formulário estar ativo.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 fim, o exemplo associa o texto da dica de ferramenta a dois controles Button em um CheckBoxformulário, a e a.Finally, the example associates ToolTip text with two controls on a form, a Button and a CheckBox. O exemplo de código requer que o método definido no exemplo esteja localizado em um Form que contenha Button um controle button1 chamado e CheckBox um controle checkBox1chamado, e que o método seja chamado a partir do Construtor Formdo.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

Comentários

Com a ToolTip classe, você pode fornecer dicas para um usuário quando o usuário coloca o ponteiro em um controle.With the ToolTip class, you can provide hints to a user when the user places the pointer on a control. A ToolTip classe normalmente é usada para alertar os usuários para o uso pretendido de um controle.The ToolTip class is typically used to alert users to the intended use of a control. Por exemplo, você pode especificar o texto da dica TextBox de ferramenta para um controle que aceite um nome, especificando o formato do nome a ser digitado no controle.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. Além de fornecer dicas, você também pode usar a ToolTip classe para fornecer informações de status de tempo de execução.In addition to providing hints, you can also use the ToolTip class to provide run time status information. Por exemplo, você pode usar a ToolTip classe para exibir a velocidade da conexão e os dados de qualidade da linha quando o usuário PictureBox move o ponteiro para um controle que exibe o status da conexão com a 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.

A ToolTip classe pode ser usada em qualquer contêiner.The ToolTip class can be used in any container. Para especificar explicitamente um contêiner, use o ToolTip(IContainer) Construtor.To explicitly specify a container, use the ToolTip(IContainer) constructor. Um único ToolTip componente normalmente é usado para criar dicas de ferramenta para vários controles em um único Formulário.A single ToolTip component typically is used to create ToolTips for multiple controls on a single form. Depois de criar um ToolTip, use uma chamada separada para o SetToolTip método para associar o texto de exibição da dica de ferramenta a um controle individual.After you create a ToolTip, use a separate call to the SetToolTip method to associate ToolTip display text to an individual control. Em seguida, quando o usuário move o ponteiro em um controle, a dica de ferramenta com seu texto é exibida.Then when the user moves the pointer on a control, the ToolTip with its text is displayed. Você pode chamar SetToolTip mais de uma vez para o mesmo controle para alterar o texto associado ao controle.You can call SetToolTip more than once for the same control to change the text that is associated with the control. Para obter o texto associado a um controle, use o GetToolTip método.To get the text that is associated with a control, use the GetToolTip method. Para remover todas as associações de texto de dica de ferramenta ToolTip com uma instância da RemoveAll classe, use o método.To remove all ToolTip text associations with an instance of the ToolTip class, use the RemoveAll method.

Observação

O texto da dica de ferramenta não é exibido para controles que estão desabilitados.ToolTip text is not displayed for controls that are disabled. A menos ShowAlways que a propriedade seja truedefinida como, as dicas de ferramentas não serão exibidas quando o contêiner estiver inativo.Unless the ShowAlways property is set to true, ToolTips are not displayed when their container is inactive.

A ToolTip classe fornece as propriedades e os métodos a seguir para modificar o comportamento padrão e a aparência de uma dica de ferramenta.The ToolTip class provides the following properties and methods to modify the default behavior and appearance of a ToolTip.

CategoriaCategory Membros associadosAssociated members
Exibição manualManual display Active, Show, Hide, ShowAlways, Popup, StopTimerActive, Show, Hide, ShowAlways, Popup, StopTimer
Tempo de dica de ferramentaToolTip timing AutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimerAutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimer
ConteúdoContent SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAllSetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAll
AparênciaAppearance BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFadingBackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFading

Se você quiser desabilitar todo o texto de dica de ferramenta para que ele não possa ser exibido em seu aplicativo, Active você poderá usar a propriedade.If you want to disable all ToolTip text so that it cannot be displayed in your application, you can use the Active property. Normalmente, a dica de ferramenta é desenhada pelo sistema operacional, mas para personalizar ToolTipa aparência do, você OwnerDraw pode definir true a propriedade como Draw e manipular o evento.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.

A ToolTipTitle classe implementa a System.ComponentModel.IExtenderProvider interface, que tem um único método, CanExtend.The ToolTipTitle class implements the System.ComponentModel.IExtenderProvider interface, which has a single method, CanExtend. As dicas de ferramentas estendem os controles no mesmo formulário em tempo ToolTip de design, adicionando uma propriedade.ToolTips extend controls on the same form at design time, adding a ToolTip property. Para obter mais informações sobre provedores de extensor, consulte provedoresde extensor.For more information about extender providers, see Extender Providers.

Construtores

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

Inicializa uma nova instância de ToolTip com um contêiner especificado.Initializes a new instance of the ToolTip without a specified container.

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

Inicializa uma nova instância da classe ToolTip com um contêiner especificado.Initializes a new instance of the ToolTip class with a specified container.

Propriedades

Active Active Active Active

Obtém ou define um valor que indica se a dica de ferramenta está ativa no momento.Gets or sets a value indicating whether the ToolTip is currently active.

AutomaticDelay AutomaticDelay AutomaticDelay AutomaticDelay

Obtém ou define o atraso automático para a dica de ferramenta.Gets or sets the automatic delay for the ToolTip.

AutoPopDelay AutoPopDelay AutoPopDelay AutoPopDelay

Obtém ou define o período em que ToolTip permanecerá visível se o ponteiro estiver parado em um controle com o texto de ToolTip 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

Obtém ou define a cor da tela de fundo do ToolTip.Gets or sets the background color for the ToolTip.

CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Obtém um valor que indica se o componente pode acionar um evento.Gets a value indicating whether the component can raise an event.

(Inherited from Component)
Container Container Container Container

Obtém o IContainer que contém o Component.Gets the IContainer that contains the Component.

(Inherited from Component)
CreateParams CreateParams CreateParams CreateParams

Obtém os parâmetros de criação para a janela ToolTip.Gets the creation parameters for the ToolTip window.

DesignMode DesignMode DesignMode DesignMode

Obtém um valor que indica se o Component está no modo de design no momento.Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
Events Events Events Events

Obtém a lista de manipuladores de eventos que estão anexados a este Component.Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
ForeColor ForeColor ForeColor ForeColor

Obtém ou define a cor de primeiro plano da dica de ferramenta.Gets or sets the foreground color for the ToolTip.

InitialDelay InitialDelay InitialDelay InitialDelay

Obtém ou define o tempo decorrido antes que a dica de ferramenta seja exibida.Gets or sets the time that passes before the ToolTip appears.

IsBalloon IsBalloon IsBalloon IsBalloon

Obtém ou define um valor que indica se a dica de ferramenta deve usar uma janela de balão.Gets or sets a value indicating whether the ToolTip should use a balloon window.

OwnerDraw OwnerDraw OwnerDraw OwnerDraw

Obtém ou define um valor que indica se a dica de ferramenta é desenhada pelo sistema operacional ou pelo código que você fornece.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

Obtém ou define o período de tempo que deve ocorrer antes que as janelas de dica de ferramenta subsequentes sejam exibidas à medida que o ponteiro se move de um controle para outro.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

Obtém ou define um valor que indica se uma janela Dica de ferramenta é exibida, mesmo quando seu controle pai não está ativo.Gets or sets a value indicating whether a ToolTip window is displayed, even when its parent control is not active.

Site Site Site Site

Obtém ou define o ISite do Component.Gets or sets the ISite of the Component.

(Inherited from Component)
StripAmpersands StripAmpersands StripAmpersands StripAmpersands

Obtém ou define um valor que determina como os caracteres de E comercial (&) são tratados.Gets or sets a value that determines how ampersand (&) characters are treated.

Tag Tag Tag Tag

Obtém ou define o objeto que contém os dados fornecidos pelo programador associados com o ToolTip.Gets or sets the object that contains programmer-supplied data associated with the ToolTip.

ToolTipIcon ToolTipIcon ToolTipIcon ToolTipIcon

Obtém ou define um valor que define o tipo de ícone a ser exibido ao lado do texto de dica de ferramenta.Gets or sets a value that defines the type of icon to be displayed alongside the ToolTip text.

ToolTipTitle ToolTipTitle ToolTipTitle ToolTipTitle

Obtém ou define um título para a janela de ToolTip.Gets or sets a title for the ToolTip window.

UseAnimation UseAnimation UseAnimation UseAnimation

Obtém ou define um valor que determina se um efeito de animação deve ser usado ao exibir a Dica de Ferramenta.Gets or sets a value determining whether an animation effect should be used when displaying the ToolTip.

UseFading UseFading UseFading UseFading

Obtém ou define um valor que determina se um efeito de esmaecimento deve ser usado ao exibir a Dica de Ferramenta.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)

Retorna true se a dica de ferramenta pode oferecer uma propriedade de extensão para o 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)

Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um 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 os recursos usados pelo Component.Releases all resources used by the Component.

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

Libera os recursos não gerenciados usados pelo Component e opcionalmente libera os recursos gerenciados.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

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

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

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

Libera os recursos não gerenciados e executa outras operações de limpeza antes que Cursor seja recuperado pelo coletor de lixo.Releases the unmanaged resources and performs other cleanup operations before the Cursor is reclaimed by the garbage collector.

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

Serve como a função de hash padrão.Serves as the default hash function.

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

Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância.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)

Retorna um objeto que representa um serviço fornecido pelo Component ou pelo seu 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 o texto da dica de ferramenta associado ao controle especificado.Retrieves the ToolTip text associated with the specified control.

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

Obtém o Type da instância atual.Gets the Type of the current instance.

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

Oculta a janela de dica de ferramenta especificada.Hides the specified ToolTip window.

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

Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância.Obtains a lifetime service object to control the lifetime policy for this instance.

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

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

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

Cria uma cópia superficial do objeto MarshalByRefObject atual.Creates a shallow copy of the current MarshalByRefObject object.

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

Remove todo texto de dica de ferramenta associado atualmente com o componente de dica de ferramenta.Removes all ToolTip text currently associated with the ToolTip component.

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

Associa o texto ToolTip ao controle especificado.Associates ToolTip text with the specified control.

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

Define o texto de ToolTip associado ao controle especificado e exibe a ToolTip de forma restrita.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)

Define o texto da dica de ferramenta associada ao controle especificado e exibe a dica de ferramenta pela duração indicada.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)

Define o texto de dica de contexto associado ao controle especificado e então exibe a dica de forma restrita na posição 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)

Define o texto da dica de ferramenta associada ao controle especificado e a exibe pela duração indicada na posição relativa especificada.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)

Define o texto de dica de contexto associado ao controle especificado e então exibe a dica de forma restrita na posição 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)

Define o texto da dica de ferramenta associada ao controle especificado e a exibe pela duração indicada na posição relativa especificada.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()

Interrompe o cronômetro que oculta as dicas de ferramenta exibidas.Stops the timer that hides displayed ToolTips.

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

Retorna uma representação de cadeia de caracteres para este controle.Returns a string representation for this control.

Eventos

Disposed Disposed Disposed Disposed

Ocorre quando o componente é disposto por uma chamada para o método Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)
Draw Draw Draw Draw

Ocorre quando a dica de ferramenta é desenhada e a propriedade OwnerDraw é definida como true e a propriedade IsBalloon é 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

Ocorre antes que uma dica de ferramenta seja exibida inicialmente.Occurs before a ToolTip is initially displayed. Trata-se do evento padrão para a classe ToolTip.This is the default event for the ToolTip class.

Aplica-se a

Veja também