ToolTip Classe

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Origem:

ToolTip.cs

Representa uma pequena janela pop-up retangular que exibe uma breve descrição da finalidade de um controle quando o usuário posiciona o ponteiro no controle.

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

Object

MarshalByRefObject

Component

ToolTip

Implementações

IExtenderProvider

Exemplos

O exemplo de código a ToolTip seguir cria uma instância da classe e associa a instância à Form qual a instância é criada. Em seguida, InitialDelayo código inicializa as propriedades AutoPopDelayde atraso e ReshowDelay. Além disso, a instância da ToolTip classe define a propriedade para true permitir que o ShowAlways texto tooltip sempre seja exibido, independentemente de o formulário estar ativo. Por fim, o exemplo associa o texto tooltip a dois controles em um formulário, um Button e um CheckBox. O exemplo de código requer que o método definido no exemplo esteja localizado em um Form que contém um Button controle nomeado button1 e um CheckBox controle nomeado checkBox1e que o método seja chamado do construtor do 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 a um usuário quando o usuário coloca o ponteiro em um controle. Normalmente ToolTip , a classe é usada para alertar os usuários sobre o uso pretendido de um controle. Por exemplo, você pode especificar o texto tooltip para um TextBox controle que aceita um nome, especificando o formato do nome a ser digitado no controle. Além de fornecer dicas, você também pode usar a ToolTip classe para fornecer informações de status de tempo de execução. Por exemplo, você pode usar a ToolTip classe para exibir dados de velocidade de conexão e qualidade de linha quando o usuário move o ponteiro para um PictureBox controle que exibe o status da conexão com a Internet.

A ToolTip classe pode ser usada em qualquer contêiner. Para especificar explicitamente um contêiner, use o ToolTip(IContainer) construtor. Normalmente, um único ToolTip componente é usado para criar Dicas de Ferramentas para vários controles em um único formulário. Depois de criar uma ToolTipchamada, use uma chamada separada ao método para associar o SetToolTip texto de exibição da Dica de Ferramenta a um controle individual. Em seguida, quando o usuário move o ponteiro em um controle, a Dica de Ferramenta com seu texto é exibida. Você pode chamar SetToolTip mais de uma vez para o mesmo controle para alterar o texto associado ao controle. Para obter o texto associado a um controle, use o GetToolTip método. Para remover todas as associações de texto tooltip com uma instância da ToolTip classe, use o RemoveAll método.

Observação

O texto da Dica de Ferramenta não é exibido para controles desabilitados. A menos que a ShowAlways propriedade esteja definida como true, as Dicas de Ferramentas não serão exibidas quando o contêiner estiver inativo.

A ToolTip classe fornece as seguintes propriedades e métodos para modificar o comportamento padrão e a aparência de uma Dica de Ferramenta.

Categoria	Membros associados
Exibição manual	Active, Show, Hide, ShowAlways, Popup, , StopTimer
Tempo de Dica de Ferramenta	AutoPopDelay, InitialDelay, ReshowDelay, , AutomaticDelayStopTimer
Conteúdo	SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, , RemoveAll
Aparência	BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, , UseFading

Se você quiser desabilitar todo o texto da Dica de Ferramenta para que ele não possa ser exibido em seu aplicativo, você poderá usar a Active propriedade. Normalmente, a Dica de Ferramenta é desenhada pelo sistema operacional, mas para personalizar a aparência do ToolTipevento, você pode definir a OwnerDraw propriedade true e manipular o Draw evento.

A ToolTipTitle classe implementa a System.ComponentModel.IExtenderProvider interface, que tem um único método. CanExtend As Dicas de Ferramenta estendem os controles no mesmo formulário em tempo de design, adicionando uma ToolTip propriedade. Para obter mais informações sobre provedores de extensor, consulte Provedores de Extensor.

Construtores

Nome	Description
ToolTip()	Inicializa uma nova instância do ToolTip contêiner sem um especificado.
ToolTip(IContainer)	Inicializa uma nova instância da ToolTip classe com um contêiner especificado.

Propriedades

Nome	Description
Active	Obtém ou define um valor que indica se a Dica de Ferramenta está ativa no momento.
AutomaticDelay	Obtém ou define o atraso automático para a Dica de Ferramenta.
AutoPopDelay	Obtém ou define o período de tempo em que a Dica de Ferramenta permanece visível se o ponteiro estiver parado em um controle com o texto tooltip especificado.
BackColor	Obtém ou define a cor da tela de fundo para a Dica de Ferramenta.
CreateParams	Obtém os parâmetros de criação para a janela Dica de Ferramenta.
ForeColor	Obtém ou define a cor do primeiro plano para a Dica de Ferramenta.
InitialDelay	Obtém ou define o tempo que passa antes que a Dica de Ferramenta seja exibida.
IsBalloon	Obtém ou define um valor que indica se a Dica de Ferramenta deve usar uma janela de balão.
OwnerDraw	Obtém ou define um valor que indica se a Dica de Ferramenta é desenhada pelo sistema operacional ou pelo código fornecido.
ReshowDelay	Obtém ou define o período de tempo que deve ocorrer antes que as janelas subsequentes da Dica de Ferramenta apareçam à medida que o ponteiro se move de um controle para outro.
ShowAlways	Obtém ou define um valor que indica se uma janela ToolTip é exibida, mesmo quando seu controle pai não está ativo.
StripAmpersands	Obtém ou define um valor que determina como os caracteres escare (&) são tratados.
Tag	Obtém ou define o objeto que contém dados fornecidos pelo programador associados ao ToolTip.
ToolTipIcon	Obtém ou define um valor que define o tipo de ícone a ser exibido junto com o texto da Dica de Ferramenta.
ToolTipTitle	Obtém ou define um título para a janela Dica de Ferramenta.
UseAnimation	Obtém ou define um valor que determina se um efeito de animação deve ser usado ao exibir a Dica de Ferramenta.
UseFading	Obtém ou define um valor que determina se um efeito fade deve ser usado ao exibir a Dica de Ferramenta.

Métodos

Nome	Description
CanExtend(Object)	Retorna true se a Dica de Ferramenta puder oferecer uma propriedade de extensor para o componente de destino especificado.
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo Component e, opcionalmente, libera os recursos gerenciados.
Finalize()	Libera os recursos não gerenciados e executa outras operações de limpeza antes de serem Cursor recuperados pelo coletor de lixo.
GetToolTip(Control)	Recupera o texto tooltip associado ao controle especificado.
Hide(IWin32Window)	Oculta a janela ToolTip especificada.
RemoveAll()	Remove todo o texto tooltip atualmente associado ao componente ToolTip.
SetToolTip(Control, String)	Associa o texto tooltip ao controle especificado.
Show(String, IWin32Window, Int32, Int32, Int32)	Define o texto tooltip associado ao controle especificado e exibe a Dica de Ferramenta para a duração especificada na posição relativa especificada.
Show(String, IWin32Window, Int32, Int32)	Define o texto tooltip associado ao controle especificado e, em seguida, exibe a Dica de Ferramenta modamente na posição relativa especificada.
Show(String, IWin32Window, Int32)	Define o texto tooltip associado ao controle especificado e exibe a Dica de Ferramenta para a duração especificada.
Show(String, IWin32Window, Point, Int32)	Define o texto tooltip associado ao controle especificado e exibe a Dica de Ferramenta para a duração especificada na posição relativa especificada.
Show(String, IWin32Window, Point)	Define o texto tooltip associado ao controle especificado e, em seguida, exibe a Dica de Ferramenta modamente na posição relativa especificada.
Show(String, IWin32Window)	Define o texto tooltip associado ao controle especificado e exibe a Dica de Ferramenta modamente.
StopTimer()	Interrompe o temporizador que oculta dicas de ferramenta exibidas.
ToString()	Retorna uma representação de cadeia de caracteres para esse controle.

Eventos

Nome	Description
Draw	Ocorre quando a Dica de Ferramenta é desenhada e a OwnerDraw propriedade é definida true como e a IsBalloon propriedade é false.
Popup	Ocorre antes de uma Dica de Ferramenta ser exibida inicialmente. Esse é o evento padrão para a ToolTip classe.

Confira também

• ToolTipIcon
• HelpProvider
• Provedores de extensor
• Componente ToolTip (Windows Forms)