ToolTip.SetToolTip(Control, String) Método

  • Referência

Definição

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Associa o texto ToolTip ao controle especificado.

public:
 void SetToolTip(System::Windows::Forms::Control ^ control, System::String ^ caption);
public void SetToolTip (System.Windows.Forms.Control control, string caption);
public void SetToolTip (System.Windows.Forms.Control control, string? caption);
member this.SetToolTip : System.Windows.Forms.Control * string -> unit
Public Sub SetToolTip (control As Control, caption As String)

Parâmetros

control
Control

O Control ao qual associar o texto ToolTip.

caption
String

O texto ToolTip a ser exibido quando o ponteiro está sobre o controle.

Exemplos

O exemplo de código a seguir cria uma instância da ToolTip classe e associa a instância ao Form em que 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 para true habilitar o texto tooltip a ser 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. Este exemplo 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 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

Além de especificar o texto tooltip a ser exibido para um controle, você também pode usar esse método para modificar o texto tooltip para um controle. Chamar o SetToolTip método mais de uma vez para um determinado controle não especifica vários textos tooltip a serem exibidos para um controle, mas altera o texto da Dica de Ferramenta atual para o controle. Para determinar o texto tooltip associado a um controle em tempo de execução, use o GetToolTip método .

Como regra geral, o texto usado deve ser curto; no entanto, você pode inserir quebras de linha usando a \r\n sequência de caracteres de escape. E comercial (&) no texto são tratados conforme descrito pela StripAmpersands propriedade .

Aplica-se a

Confira também