ToolTip クラス

定義

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

public ref class ToolTip sealed : System::ComponentModel::Component, System::ComponentModel::IExtenderProvider
public ref class ToolTip : System::ComponentModel::Component, System::ComponentModel::IExtenderProvider
public sealed 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 NotInheritable Class ToolTip
Inherits Component
Implements IExtenderProvider
Public Class ToolTip
Inherits Component
Implements IExtenderProvider
継承
実装

次のコード例では、クラスのインスタンスを作成し、インスタンス ToolTip Form が作成されたに関連付けます。 次に、このコードは、遅延プロパティ、、およびを初期化し AutoPopDelay InitialDelay ReshowDelay ます。 さらに、クラスのインスタンスによって ToolTip プロパティがに設定され、 ShowAlways true フォームがアクティブかどうかに関係なく、ツールヒントテキストが常に表示されるようになります。 最後に、フォームの2つのコントロール (および) にツールヒントテキストを関連付け Button CheckBox ます。 このコード例では、例で定義されているメソッドが、という名前のコントロールとという名前のコントロールを含む内にあり、 Form Button button1 CheckBox checkBox1 メソッドがのコンストラクターから呼び出さ 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 通常、ユーザーにコントロールの使用目的を通知するために使用されます。 たとえば、名前を受け取るコントロールのツールヒントテキストを指定し TextBox 、コントロールに入力される名前の形式を指定できます。 ヒントを提供するだけでなく、クラスを使用して実行時の状態情報を提供することもでき ToolTip ます。 たとえば、 ToolTip ユーザーがポインターをインターネット接続の状態を表示するコントロールに移動したときに、クラスを使用して接続速度と線の品質データを表示でき PictureBox ます。

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

注意

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

クラスには、 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 1 つのメソッドを持つインターフェイスを実装し 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

ComponentISite を取得または設定します。

(継承元 Component)
StripAmpersands

アンパサンド (&) 文字の処理方法を決定する値を取得または設定します。

Tag

ToolTip 関連のプログラマが指定した データを格納するオブジェクトを取得または設定します。

ToolTipIcon

ツールヒント テキストの横に表示するアイコンの種類を定義する値を取得または設定します。

ToolTipTitle

ツールヒント ウィンドウのタイトルを取得または設定します。

UseAnimation

ツールヒントを表示するときに、アニメーション効果を使用するかどうかを決定する値を取得または設定します。

UseFading

ツールヒントを表示するときに、フェード効果を使用するかどうかを決定する値を取得または設定します。

メソッド

CanExtend(Object)

ツールヒントが、指定した対象コンポーネントにエクステンダー プロパティを追加できる場合に true を返します。

CreateObjRef(Type)

リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。

(継承元 MarshalByRefObject)
Dispose()

Component によって使用されているすべてのリソースを解放します。

(継承元 Component)
Dispose(Boolean)

Component によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。

Dispose(Boolean)

Component によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。

(継承元 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 クラスの既定のイベントです。

適用対象

こちらもご覧ください