ToolTip.SetToolTip メソッド

.NET Framework クラス ライブラリ リファレンス

ToolTip.SetToolTip メソッド

指定したコントロールにツール ヒント テキストを関連付けます。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Sub SetToolTip ( _
    control As Control, _
    caption As String _
)

Visual Basic (使用法)

Dim instance As ToolTip
Dim control As Control
Dim caption As String

instance.SetToolTip(control, caption)

C#

public void SetToolTip (
    Control control,
    string caption
)

C++

public:
void SetToolTip (
    Control^ control, 
    String^ caption
)

J#

public void SetToolTip (
    Control control, 
    String caption
)

JScript

public function SetToolTip (
    control : Control, 
    caption : String
)

パラメータ

control

ツール ヒント テキストを関連付ける Control。

caption

ポインタがコントロール上にあるときに表示されるツールヒント テキスト。

解説

コントロールに表示するツール ヒント テキストを指定するだけでなく、このメソッドを使用してコントロールのツール ヒント テキストを変更することもできます。指定したコントロールに対して SetToolTip メソッドを複数回呼び出すと、コントロールに表示するツールヒント テキストが複数指定されるのではなく、そのコントロールの現在のツールヒント テキストが変更されます。実行時にコントロールに関連付けられるツールヒント テキストを決定するには、GetToolTip メソッドを使用します。

一般に、テキストは短くする必要がありますが、エスケープ文字シーケンス (\r\n) を使用すると、改行を挿入できます。テキスト内のアンパサンド (&) は、StripAmpersands プロパティでの指定に従って処理されます。

使用例

ToolTip クラスのインスタンスを作成し、それを作成した場所である Form に、このインスタンスを関連付けるコード例を次に示します。次に、このコードは AutoPopDelay、InitialDelay、ReshowDelay の各遅延プロパティを初期化します。また、ToolTip クラスのインスタンスで ShowAlways プロパティを true に設定して、フォームがアクティブかどうかに関係なく、ツール ヒント テキストが表示されるようにします。最後に、ツール ヒント テキストをフォーム上の 2 つのコントロール Button および CheckBox に関連付けます。この例では、コード内で定義されたメソッドが、button1 という名前の Button コントロールおよび checkBox1 という名前の CheckBox コントロールを含む Form 内に配置されており、そのメソッドが Form のコンストラクタから呼び出される必要があります。

Visual Basic

' 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

C#

// 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");
}

C++

// 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"
 );
}

J#

// 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