ToolTip.SetToolTip 方法

使工具提示文本与指定的控件相关联。

**命名空间:**System.Windows.Forms
**程序集:**System.Windows.Forms(在 system.windows.forms.dll 中)

语法

声明
Public Sub SetToolTip ( _
    control As Control, _
    caption As String _
)
用法
Dim instance As ToolTip
Dim control As Control
Dim caption As String

instance.SetToolTip(control, caption)
public void SetToolTip (
    Control control,
    string caption
)
public:
void SetToolTip (
    Control^ control, 
    String^ caption
)
public void SetToolTip (
    Control control, 
    String caption
)
public function SetToolTip (
    control : Control, 
    caption : String
)

参数

  • control
    要将工具提示文本与其关联的 Control
  • caption
    指针位于控件上方时要显示的工具提示文本。

备注

除了为控件指定要显示的工具提示文本外,还可使用此方法修改控件的工具提示文本。为给定控件多次调用 SetToolTip 方法不会为控件指定要显示的多个工具提示文本,而只会更改该控件的当前工具提示文本。若要在运行时确定与控件关联的工具提示文本,请使用 GetToolTip 方法。

作为一条通用规则,所用的文本应该简短;但是,可以使用 \r\n 转义字符序列插入分行符。文本中的“and”字符 (&) 按照 StripAmpersands 属性的描述进行处理。

示例

下面的代码示例创建一个 ToolTip 类的实例,并将该实例与创建它时所在的 Form 相关联。代码随后初始化延迟属性 AutoPopDelayInitialDelayReshowDelay。另外,ToolTip 类的实例将 ShowAlways 属性设置为 true,以使工具提示文本始终显示而不管窗体是否活动。最后,该示例将工具提示文本与窗体上的 ButtonCheckBox 这两个控件关联。此示例要求其中定义的方法位于 Form 之内,而该窗体应包含一个名为 button1Button 控件和一个名为 checkBox1CheckBox 控件,并且要求从 Form 的构造函数中调用该方法。

' 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
// 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.
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.set_AutoPopDelay(5000);
    toolTip1.set_InitialDelay(1000);
    toolTip1.set_ReshowDelay(500);
    // Force the ToolTip text to be displayed whether or not the form
    // is active.
    toolTip1.set_ShowAlways(true);
    // Set up the ToolTip text for the Button and Checkbox.
    toolTip1.SetToolTip(this.button1, "My button1");
    toolTip1.SetToolTip(this.checkBox1, "My checkBox1");
} //Form1_Load

平台

Windows 98、Windows 2000 SP4、Windows CE、Windows Millennium Edition、Windows Mobile for Pocket PC、Windows Mobile for Smartphone、Windows Server 2003、Windows XP Media Center Edition、Windows XP Professional x64 Edition、Windows XP SP2、Windows XP Starter Edition

.NET Framework 并不是对每个平台的所有版本都提供支持。有关受支持版本的列表,请参见系统要求

版本信息

.NET Framework

受以下版本支持:2.0、1.1、1.0

请参见

参考

ToolTip 类
ToolTip 成员
System.Windows.Forms 命名空间
GetToolTip
StripAmpersands
ToString
ToolTipTitle
Tag