ToolTip Classe

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

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.

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 seguir cria uma instância da ToolTip classe e associa a instância à Form na qual a instância é criada. Em seguida, o código inicializa as propriedades AutoPopDelayde atraso , InitialDelaye ReshowDelay. Além disso, a instância da ToolTip classe define a ShowAlways propriedade como true para habilitar o texto tooltip a ser sempre 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 chamado button1 e um CheckBox controle chamado checkBox1, e que o método é 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 Ferramenta para vários controles em um único formulário. Depois de criar um ToolTip, use uma chamada separada ao método para associar o SetToolTip texto de exibição tooltip 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 que o mesmo controle altere 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 Ferramenta 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, AutomaticDelay, StopTimer
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 ToolTip, você pode definir a OwnerDraw propriedade como 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

ToolTip()	Inicializa uma nova instância de ToolTip com um contêiner especificado.
ToolTip(IContainer)	Inicializa uma nova instância da classe ToolTip com um contêiner especificado.

Propriedades

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 em que ToolTip permanecerá visível se o ponteiro estiver parado em um controle com o texto de ToolTip especificado.
BackColor	Obtém ou define a cor da tela de fundo do ToolTip.
CanRaiseEvents	Obtém um valor que indica se o componente pode acionar um evento. (Herdado de Component)
Container	Obtém o IContainer que contém o Component. (Herdado de Component)
CreateParams	Obtém os parâmetros de criação para a janela ToolTip.
DesignMode	Obtém um valor que indica se o Component está no modo de design no momento. (Herdado de Component)
Events	Obtém a lista de manipuladores de eventos que estão anexados a este Component. (Herdado de Component)
ForeColor	Obtém ou define a cor de primeiro plano da dica de ferramenta.
InitialDelay	Obtém ou define o tempo decorrido 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 que você fornece.
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.
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.
Site	Obtém ou define o ISite do Component. (Herdado de Component)
StripAmpersands	Obtém ou define um valor que determina como os caracteres de E comercial (&) são tratados.
Tag	Obtém ou define o objeto que contém os dados fornecidos pelo programador associados com o ToolTip.
ToolTipIcon	Obtém ou define um valor que define o tipo de ícone a ser exibido ao lado do texto de dica de ferramenta.
ToolTipTitle	Obtém ou define um título para a janela de ToolTip.
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 de esmaecimento deve ser usado ao exibir a Dica de Ferramenta.

Métodos

CanExtend(Object)	Retorna true se a dica de ferramenta pode oferecer uma propriedade de extensão para o componente de destino especificado.
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. (Herdado de MarshalByRefObject)
Dispose()	Libera todos os recursos usados pelo Component. (Herdado de Component)
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo Component e opcionalmente libera os recursos gerenciados.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
Finalize()	Libera os recursos não gerenciados e executa outras operações de limpeza antes que Cursor seja recuperado pelo coletor de lixo.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
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. (Herdado de MarshalByRefObject)
GetService(Type)	Retorna um objeto que representa um serviço fornecido pelo Component ou pelo seu Container. (Herdado de Component)
GetToolTip(Control)	Recupera o texto da dica de ferramenta associado ao controle especificado.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
Hide(IWin32Window)	Oculta a janela de dica de ferramenta especificada.
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. (Herdado de MarshalByRefObject)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
MemberwiseClone(Boolean)	Cria uma cópia superficial do objeto MarshalByRefObject atual. (Herdado de MarshalByRefObject)
RemoveAll()	Remove todo texto de dica de ferramenta associado atualmente com o componente de dica de ferramenta.
SetToolTip(Control, String)	Associa o texto ToolTip ao controle especificado.
Show(String, IWin32Window)	Define o texto de ToolTip associado ao controle especificado e exibe a ToolTip de forma restrita.
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.
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.
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.
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.
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.
StopTimer()	Interrompe o cronômetro que oculta as dicas de ferramenta exibidas.
ToString()	Retorna uma representação de cadeia de caracteres para este controle.

Eventos

Disposed	Ocorre quando o componente é disposto por uma chamada ao método Dispose(). (Herdado de Component)
Draw	Ocorre quando a dica de ferramenta é desenhada e a propriedade OwnerDraw é definida como true e a propriedade IsBalloon é false.
Popup	Ocorre antes que uma dica de ferramenta seja exibida inicialmente. Trata-se do evento padrão para a classe ToolTip.

Confira também

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