ToolTip クラス
ユーザーがポインタをコントロール上に配置したときに、そのコントロールの目的の簡単な説明を表示する、小さい四角形のポップアップ ウィンドウを表します。
名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文
'宣言
Public Class ToolTip
Inherits Component
Implements IExtenderProvider
'使用
Dim instance As ToolTip
public class ToolTip : Component, IExtenderProvider
public ref class ToolTip : public Component, IExtenderProvider
public class ToolTip extends Component implements IExtenderProvider
public class ToolTip extends Component implements IExtenderProvider
解説
ToolTip クラスを使用すると、ユーザーがポインタをコントロール上に配置したときに、ユーザーにヒントを提示できます。ToolTip クラスは、通常、コントロールの本来の用途をユーザーに警告するために使用します。たとえば、名前を受け入れる TextBox コントロールには、コントロールに入力する名前の書式を指定するツールヒント テキストを指定できます。ヒントを提示するだけではなく、ToolTip クラスを使用して、実行時のステータス情報も提示できます。たとえば、ToolTip クラスを使用して、インターネットの接続ステータスを表示する PictureBox コントロール上にユーザーがポインタを移動したときに、接続速度と回線の品質に関するデータが表示されるようにできます。
ToolTip クラスは、すべてのコンテナで使用できます。コンテナを明示的に指定するには、ToolTip(IContainer) コンストラクタを使用します。通常、1 つの ToolTip コンポーネントを使用して、1 つのフォーム上にある複数のコントロールのツールヒントを作成します。ToolTip を作成したら、SetToolTip メソッドを個別に呼び出して、ツールヒントの表示テキストを各コントロールに関連付けます。これにより、ユーザーがポインタをコントロール上に配置すると、ツールヒントとそのテキストが表示されるようになります。同じコントロールについて SetToolTip を複数回呼び出すことにより、コントロールに関連付けられたテキストを変更できます。コントロールに関連付けられているテキストを取得するには、GetToolTip メソッドを使用します。ToolTip クラスのインスタンスに関連付けられているすべてのツール ヒント テキストを削除するには、RemoveAll メソッドを使用します。
注意
ツール ヒント テキストは、無効にされているコントロールに対しては表示されません。ShowAlways プロパティが true に設定されている場合を除き、コンテナがアクティブでないときには、ツールヒントは表示されません。
ToolTip クラスには、ツールヒントの既定の動作と外観を変更するために次のプロパティとメソッドが用意されています。
カテゴリ |
関連するメンバ |
|---|---|
手動による表示 |
|
ツールヒントのタイミング |
AutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimer |
内容 |
SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAll |
外観 |
BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFading |
すべてのツールヒント テキストを無効にすることにより、アプリケーションで表示されないようにするには、Active プロパティを使用します。通常、ツールヒントはオペレーティング システムによって描画されますが、ToolTip の外観をカスタマイズするには、OwnerDraw プロパティを true に設定し、Draw イベントを処理します。
ToolTipTitle クラスは、System.ComponentModel.IExtenderProvider インターフェイスを実装しています。このインターフェイスには、CanExtend という単一のメソッドがあります。ツールヒントは、デザイン時に同じフォーム上のコントロールを拡張し、ToolTip プロパティを追加します。拡張プロバイダの詳細については、「拡張プロバイダ」を参照してください。
使用例
ToolTip クラスのインスタンスを作成し、それを作成した場所である Form に、このインスタンスを関連付けるコード例を次に示します。次に、このコードは AutoPopDelay、InitialDelay、ReshowDelay の各遅延プロパティを初期化します。さらに、ToolTip クラスのインスタンスが ShowAlways プロパティを true に設定して、フォームがアクティブかどうかに関係なく、ツール ヒント テキストを常に表示できるようにします。最後に、ツール ヒント テキストをフォーム上の 2 つのコントロール Button および CheckBox に関連付けます。このコード例では、コード内で定義されたメソッドが、button1 という名前の Button コントロールおよび checkBox1 という名前の CheckBox コントロールを含む Form 内に配置されており、そのメソッドが 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
継承階層
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Windows.Forms.ToolTip
スレッド セーフ
この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。
プラットフォーム
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 メンバ
System.Windows.Forms 名前空間
ToolTipIcon
HelpProvider クラス