ToolTip クラス

定義

名前空間:

System.Windows.Forms

アセンブリ:

System.Windows.Forms.dll

ユーザーがポインターをコントロール上に配置したときに、そのコントロールの目的の簡単な説明を表示する、小さい四角形のポップアップ ウィンドウを表します。

public ref class ToolTip : System::ComponentModel::Component, System::ComponentModel::IExtenderProvider

public class ToolTip : System.ComponentModel.Component, System.ComponentModel.IExtenderProvider

type ToolTip = class
    inherit Component
    interface IExtenderProvider

Public Class ToolTip
Inherits Component
Implements IExtenderProvider

継承

Object

MarshalByRefObject

Component

ToolTip

実装

IExtenderProvider

例

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

注釈

クラスを ToolTip 使用すると、ユーザーがコントロールにポインターを置いたときにヒントをユーザーに提供できます。 クラスは ToolTip 、通常、コントロールの意図した使用方法をユーザーに警告するために使用されます。 たとえば、名前を受け入れるコントロールに ToolTip TextBox テキストを指定し、コントロールに入力する名前の形式を指定できます。 ヒントの提供に加えて、 クラスを使用して実行時の ToolTip 状態情報を提供することもできます。 たとえば、 クラスを ToolTip 使用すると、ユーザーがインターネット接続の状態を表示するコントロールに PictureBox ポインターを移動したときに、接続速度と回線品質データを表示できます。

クラスは ToolTip 、任意のコンテナーで使用できます。 コンテナーを明示的に指定するには、 コンストラクターを ToolTip(IContainer) 使用します。 通常、1 つの ToolTip コンポーネントを使用して、1 つのフォーム上に複数のコントロールのツールヒントを作成します。 を作成した後、 ToolTipメソッドを個別に呼び出して SetToolTip 、ツールヒントの表示テキストを個々のコントロールに関連付けます。 その後、ユーザーがコントロール上でポインターを移動すると、テキストを含むツールヒントが表示されます。 同じコントロールに対して複数回を呼び出 SetToolTip して、コントロールに関連付けられているテキストを変更できます。 コントロールに関連付けられているテキストを取得するには、 メソッドを GetToolTip 使用します。 クラスのインスタンスとすべての ToolTip テキストの ToolTip 関連付けを削除するには、 メソッドを RemoveAll 使用します。

注意

ツールヒント テキストは、無効になっているコントロールには表示されません。 プロパティが ShowAlways に true設定されていない限り、コンテナーが非アクティブな場合、ツールヒントは表示されません。

クラスには ToolTip 、ToolTip の既定の動作と外観を変更するための次のプロパティとメソッドが用意されています。

カテゴリ	関連付けられたメンバー
手動表示	Active, Show, Hide, ShowAlways, Popup, StopTimer
ツールヒントのタイミング	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()	コンテナーを指定せずに、ToolTip の新しいインスタンスを初期化します。
ToolTip(IContainer)	コンテナーを指定して、ToolTip クラスの新しいインスタンスを初期化します。

プロパティ

Active	ツールヒントが現在アクティブかどうかを示す値を取得または設定します。
AutomaticDelay	ツールヒントの自動遅延を取得または設定します。
AutoPopDelay	ツールヒント テキストが指定されたコントロール上でポインターが静止している場合に、ツールヒントが表示される時間を取得または設定します。
BackColor	ツールヒントの背景色を取得または設定します。
CanRaiseEvents	コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。 (継承元 Component)
Container	IContainer を含む Component を取得します。 (継承元 Component)
CreateParams	ツールヒント ウィンドウの作成パラメーターを取得します。
DesignMode	Component が現在デザイン モードかどうかを示す値を取得します。 (継承元 Component)
Events	Component に結び付けられているイベント ハンドラーのリストを取得します。 (継承元 Component)
ForeColor	ツールヒントの前景色を取得または設定します。
InitialDelay	ツールヒントが表示されるまでに経過する時間を取得または設定します。
IsBalloon	ツールヒントにバルーン ウィンドウを使用するかどうかを示す値を取得または設定します。
OwnerDraw	ツールヒントを、オペレーティング システムと独自のコードのどちらによって描画するのかを示す値を取得または設定します。
ReshowDelay	ポインターが 1 つのコントロールから別のコントロールに移動したときに、移動先のツールヒント ウィンドウが表示されるまでに経過する必要のある時間の長さを取得または設定します。
ShowAlways	親コントロールがアクティブではない場合でも、ツールヒント ウィンドウを表示するかどうかを示す値を取得または設定します。
Site	Component の ISite を取得または設定します。 (継承元 Component)
StripAmpersands	アンパサンド (&) 文字の処理方法を決定する値を取得または設定します。
Tag	ToolTip 関連のプログラマが指定した データを格納するオブジェクトを取得または設定します。
ToolTipIcon	ツールヒント テキストの横に表示するアイコンの種類を定義する値を取得または設定します。
ToolTipTitle	ツールヒント ウィンドウのタイトルを取得または設定します。
UseAnimation	ツールヒントを表示するときに、アニメーション効果を使用するかどうかを決定する値を取得または設定します。
UseFading	ツールヒントを表示するときに、フェード効果を使用するかどうかを決定する値を取得または設定します。

メソッド

CanExtend(Object)	ツールヒントが、指定した対象コンポーネントにエクステンダー プロパティを追加できる場合に true を返します。
CreateObjRef(Type)	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (継承元 MarshalByRefObject)
Dispose()	Component によって使用されているすべてのリソースを解放します。 (継承元 Component)
Dispose(Boolean)	Component によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
Finalize()	Cursor がガベージ コレクターによって再要求される前に、アンマネージ リソースを解放し、その他のクリーンアップ操作を実行します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetLifetimeService()	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject)
GetService(Type)	Component またはその Container で提供されるサービスを表すオブジェクトを返します。 (継承元 Component)
GetToolTip(Control)	指定したコントロールに関連付けられているツールヒント テキストを取得します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Hide(IWin32Window)	指定したツールヒント ウィンドウを非表示にします。
InitializeLifetimeService()	このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
MemberwiseClone(Boolean)	現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。 (継承元 MarshalByRefObject)
RemoveAll()	ツールヒント コンポーネントに現在関連付けられているすべてのツールヒント テキストを削除します。
SetToolTip(Control, String)	指定したコントロールにツールヒント テキストを関連付けます。
Show(String, IWin32Window)	指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントをモーダルとして表示します。
Show(String, IWin32Window, Int32)	指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した時間だけ表示します。
Show(String, IWin32Window, Int32, Int32)	指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した相対位置にモーダルとして表示します。
Show(String, IWin32Window, Int32, Int32, Int32)	指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した相対位置に指定した時間だけ表示します。
Show(String, IWin32Window, Point)	指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した相対位置にモーダルとして表示します。
Show(String, IWin32Window, Point, Int32)	指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した相対位置に指定した時間だけ表示します。
StopTimer()	表示されたツールヒントを非表示にするタイマーを停止します。
ToString()	このコントロールの文字列形式を返します。

イベント

Disposed	Dispose() メソッドの呼び出しによってコンポーネントが破棄されるときに発生します。 (継承元 Component)
Draw	ツールヒントが描画され、OwnerDraw プロパティが true に設定され、IsBalloon プロパティが false に設定されているときに発生します。
Popup	ツールヒントが最初に表示される前に発生します。 これは、ToolTip クラスの既定のイベントです。

こちらもご覧ください

• ToolTipIcon
• HelpProvider
• 拡張プロバイダー
• ToolTip コンポーネント (Windows フォーム)