ToolTip.SetToolTip(Control, String) ToolTip.SetToolTip(Control, String) ToolTip.SetToolTip(Control, String) Method

定義

指定したコントロールにツール ヒント テキストを関連付けます。Associates ToolTip text with the specified control.

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

パラメーター

control
Control Control Control

ツール ヒント テキストを関連付ける ControlThe Control to associate the ToolTip text with.

caption
String String String

ポインターがコントロール上にあるときに表示されるツールヒント テキスト。The ToolTip text to display when the pointer is on the control.

次のコード例では、 ToolTipクラスのインスタンスを作成し、インスタンスが作成されFormたに関連付けます。The following code example creates an instance of the ToolTip class and associates the instance with the Form that the instance is created within. 次に、このコードは、 AutoPopDelay遅延InitialDelayプロパティ、 ReshowDelay、およびを初期化します。The code then initializes the delay properties AutoPopDelay, InitialDelay, and ReshowDelay. さらに、 ToolTipクラスのインスタンスによってShowAlwaysプロパティがtrueに設定され、フォームがアクティブかどうかに関係なく、ツールヒントテキストが表示されるようになります。In addition the instance of the ToolTip class sets the ShowAlways property to true to enable ToolTip text to be displayed regardless of whether the form is active. 最後に、フォームの2つのコントロール ( Button CheckBoxおよび) にツールヒントテキストを関連付けます。Finally, the example associates ToolTip text with two controls on a form, a Button and a CheckBox. この例では、例で定義されているメソッドがFormbutton1というButton名前のコントロールとCheckBoxというcheckBox1名前のコントロールを含む内にあり、メソッドがのコンストラクターから呼び出されていることが必要ですFormThis 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

注釈

コントロールに表示するツールヒントテキストを指定するだけでなく、このメソッドを使用して、コントロールのツールヒントテキストを変更することもできます。In addition to specifying the ToolTip text to display for a control, you can also use this method to modify the ToolTip text for a control. 特定のコントロールに対してメソッドを複数回呼び出すと、コントロールに対して表示する複数のツールヒントテキストが指定されませんが、代わりにコントロールの現在のツールヒントテキストが変更されます。SetToolTipCalling the SetToolTip method more than once for a given control does not specify multiple ToolTip text to display for a control, but instead changes the current ToolTip text for the control. 実行時にコントロールに関連付けられているツールヒントテキストを確認するGetToolTipには、メソッドを使用します。To determine the ToolTip text that is associated with a control at run time, use the GetToolTip method.

一般的な規則として、使用するテキストは短くする必要があります。ただし、 \r\nエスケープ文字シーケンスを使用して改行を挿入することはできます。As a general rule the text used should be short; however, you can insert line breaks by using the \r\n escape character sequence. テキスト内のアンパサンド (&) は、プロパティのStripAmpersands説明に従って処理されます。Ampersands (&) in the text are handled as described by the StripAmpersands property.

適用対象

こちらもご覧ください