ToolTip クラス

定義

ユーザーがポインターをコントロール上に配置したときに、そのコントロールの目的の簡単な説明を表示する、小さい四角形のポップアップ ウィンドウを表します。Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.

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
継承
実装

次のコード例では、 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 always be display 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名前のコントロールを含んでいる内にあり、メソッドがコンストラクターから呼び出されていることが必要です。Formの。The code 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

注釈

ToolTipクラスを使用すると、ユーザーがコントロールにポインターを置いたときにヒントをユーザーに提供できます。With the ToolTip class, you can provide hints to a user when the user places the pointer on a control. ToolTipクラスは、通常、ユーザーにコントロールの使用目的を通知するために使用されます。The ToolTip class is typically used to alert users to the intended use of a control. たとえば、名前を受け取るTextBoxコントロールのツールヒントテキストを指定し、コントロールに入力される名前の形式を指定できます。For example, you can specify ToolTip text for a TextBox control that accepts a name, specifying the format of the name to be typed into the control. ヒントを提供するだけでなく、クラスを使用ToolTipして実行時の状態情報を提供することもできます。In addition to providing hints, you can also use the ToolTip class to provide run time status information. たとえば、ユーザーがポインターをインターネットToolTip接続の状態を表示するPictureBoxコントロールに移動したときに、クラスを使用して接続速度と線の品質データを表示できます。For example, you can use the ToolTip class to display connection speed and line quality data when the user moves the pointer onto a PictureBox control that displays Internet connection status.

クラスToolTipは、任意のコンテナーで使用できます。The ToolTip class can be used in any container. コンテナーを明示的に指定するにToolTip(IContainer)は、コンストラクターを使用します。To explicitly specify a container, use the ToolTip(IContainer) constructor. 1つのコンポーネントは、通常、1つのフォーム上の複数のコントロールのツールヒントを作成するために使用されます。 ToolTipA single ToolTip component typically is used to create ToolTips for multiple controls on a single form. ToolTip作成した後、メソッドを個別に呼び出すSetToolTipことで、ツールヒントの表示テキストを個々のコントロールに関連付けることができます。After you create a ToolTip, use a separate call to the SetToolTip method to associate ToolTip display text to an individual control. その後、ユーザーがコントロール上でポインターを移動すると、そのテキストと共にツールヒントが表示されます。Then when the user moves the pointer on a control, the ToolTip with its text is displayed. 同じコントロールにSetToolTip対して複数回を呼び出して、コントロールに関連付けられているテキストを変更することができます。You can call SetToolTip more than once for the same control to change the text that is associated with the control. コントロールに関連付けられているテキストを取得するにGetToolTipは、メソッドを使用します。To get the text that is associated with a control, use the GetToolTip method. ToolTipクラスのインスタンスとのすべてのツールヒントテキストの関連付けを削除するRemoveAllには、メソッドを使用します。To remove all ToolTip text associations with an instance of the ToolTip class, use the RemoveAll method.

注意

無効になっているコントロールについては、ツールヒントのテキストは表示されません。ToolTip text is not displayed for controls that are disabled. プロパティがShowAlwaystrue設定されていない限り、コンテナーが非アクティブになってもツールヒントは表示されません。Unless the ShowAlways property is set to true, ToolTips are not displayed when their container is inactive.

クラスToolTipには、ツールヒントの既定の動作と外観を変更するための次のプロパティとメソッドが用意されています。The ToolTip class provides the following properties and methods to modify the default behavior and appearance of a ToolTip.

カテゴリCategory 関連付けられたメンバーAssociated members
手動表示Manual display Active, Show, Hide, ShowAlways, Popup, StopTimerActive, Show, Hide, ShowAlways, Popup, StopTimer
ツールヒントのタイミングToolTip timing AutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimerAutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimer
ContentContent SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAllSetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAll
外観Appearance BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFadingBackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFading

すべてのツールヒントテキストを無効にして、アプリケーションに表示できないようにするには、 Activeプロパティを使用します。If you want to disable all ToolTip text so that it cannot be displayed in your application, you can use the Active property. 通常、ツールヒントはオペレーティングシステムによって描画されますが、 ToolTipの外観をカスタマイズするには、 true OwnerDraw Drawプロパティをに設定し、イベントを処理します。Usually the ToolTip is drawn by the operating system, but to customize the appearance of the ToolTip, you can set the OwnerDraw property to true and handle the Draw event.

クラスToolTipTitleは、1 System.ComponentModel.IExtenderProviderつのメソッドをCanExtend持つインターフェイスを実装します。The ToolTipTitle class implements the System.ComponentModel.IExtenderProvider interface, which has a single method, CanExtend. ツールヒントは、デザイン時にコントロールを同じフォームに拡張ToolTipし、プロパティを追加します。ToolTips extend controls on the same form at design time, adding a ToolTip property. 拡張プロバイダーの詳細については、「拡張プロバイダー」を参照してください。For more information about extender providers, see Extender Providers.

コンストラクター

ToolTip()

コンテナーを指定せずに、ToolTip の新しいインスタンスを初期化します。Initializes a new instance of the ToolTip without a specified container.

ToolTip(IContainer)

コンテナーを指定して、ToolTip クラスの新しいインスタンスを初期化します。Initializes a new instance of the ToolTip class with a specified container.

プロパティ

Active

ツール ヒントが現在アクティブかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the ToolTip is currently active.

AutomaticDelay

ツール ヒントの自動遅延を取得または設定します。Gets or sets the automatic delay for the ToolTip.

AutoPopDelay

ツールヒント テキストが指定されたコントロール上でポインターが静止している場合に、ツールヒントが表示される時間を取得または設定します。Gets or sets the period of time the ToolTip remains visible if the pointer is stationary on a control with specified ToolTip text.

BackColor

ツールヒントの背景色を取得または設定します。Gets or sets the background color for the ToolTip.

CanRaiseEvents

コンポーネントがイベントを発生させることがきるかどうかを示す値を取得します。Gets a value indicating whether the component can raise an event.

(継承元 Component)
Container

IContainer を格納している Component を取得します。Gets the IContainer that contains the Component.

(継承元 Component)
CreateParams

ツールヒント ウィンドウの作成パラメーターを取得します。Gets the creation parameters for the ToolTip window.

DesignMode

Component が現在デザイン モードかどうかを示す値を取得します。Gets a value that indicates whether the Component is currently in design mode.

(継承元 Component)
Events

Component に結び付けられているイベント ハンドラーのリストを取得します。Gets the list of event handlers that are attached to this Component.

(継承元 Component)
ForeColor

ツールヒントの前景色を取得または設定します。Gets or sets the foreground color for the ToolTip.

InitialDelay

ツール ヒントが表示されるまでに経過する時間を取得または設定します。Gets or sets the time that passes before the ToolTip appears.

IsBalloon

ツールヒントにバルーン ウィンドウを使用するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the ToolTip should use a balloon window.

OwnerDraw

ツールヒントを、オペレーティング システムと独自のコードのどちらによって描画するのかを示す値を取得または設定します。Gets or sets a value indicating whether the ToolTip is drawn by the operating system or by code that you provide.

ReshowDelay

ポインターが 1 つのコントロールから別のコントロールに移動したときに、移動先のツールヒント ウィンドウが表示されるまでに経過する必要のある時間の長さを取得または設定します。Gets or sets the length of time that must transpire before subsequent ToolTip windows appear as the pointer moves from one control to another.

ShowAlways

親コントロールがアクティブではない場合でも、ツールヒント ウィンドウを表示するかどうかを示す値を取得または設定します。Gets or sets a value indicating whether a ToolTip window is displayed, even when its parent control is not active.

Site

ComponentISite を取得または設定します。Gets or sets the ISite of the Component.

(継承元 Component)
StripAmpersands

アンパサンド (&) 文字の処理方法を決定する値を取得または設定します。Gets or sets a value that determines how ampersand (&) characters are treated.

Tag

ToolTip 関連のプログラマが指定した データを格納するオブジェクトを取得または設定します。Gets or sets the object that contains programmer-supplied data associated with the ToolTip.

ToolTipIcon

ツールヒント テキストの横に表示するアイコンの種類を定義する値を取得または設定します。Gets or sets a value that defines the type of icon to be displayed alongside the ToolTip text.

ToolTipTitle

ツールヒント ウィンドウのタイトルを取得または設定します。Gets or sets a title for the ToolTip window.

UseAnimation

ツールヒントを表示するときに、アニメーション効果を使用するかどうかを決定する値を取得または設定します。Gets or sets a value determining whether an animation effect should be used when displaying the ToolTip.

UseFading

ツールヒントを表示するときに、フェード効果を使用するかどうかを決定する値を取得または設定します。Gets or sets a value determining whether a fade effect should be used when displaying the ToolTip.

メソッド

CanExtend(Object)

ツールヒントが、指定した対象コンポーネントにエクステンダー プロパティを追加できる場合に true を返します。Returns true if the ToolTip can offer an extender property to the specified target component.

CreateObjRef(Type)

リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(継承元 MarshalByRefObject)
Dispose()

Component によって使用されているすべてのリソースを解放します。Releases all resources used by the Component.

(継承元 Component)
Dispose(Boolean)

Component によって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。Releases the unmanaged resources used by the Component and optionally releases the managed resources.

Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
Finalize()

Cursor がガベージ コレクターによって再要求される前に、アンマネージ リソースを解放し、その他のクリーンアップ操作を実行します。Releases the unmanaged resources and performs other cleanup operations before the Cursor is reclaimed by the garbage collector.

GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetLifetimeService()

対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(継承元 MarshalByRefObject)
GetService(Type)

Component またはその Container で提供されるサービスを表すオブジェクトを返します。Returns an object that represents a service provided by the Component or by its Container.

(継承元 Component)
GetToolTip(Control)

指定したコントロールに関連付けられているツール ヒント テキストを取得します。Retrieves the ToolTip text associated with the specified control.

GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
Hide(IWin32Window)

指定したツールヒント ウィンドウを非表示にします。Hides the specified ToolTip window.

InitializeLifetimeService()

このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。Obtains a lifetime service object to control the lifetime policy for this instance.

(継承元 MarshalByRefObject)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
MemberwiseClone(Boolean)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。Creates a shallow copy of the current MarshalByRefObject object.

(継承元 MarshalByRefObject)
RemoveAll()

ツールヒント コンポーネントに現在関連付けられているすべてのツールヒント テキストを削除します。Removes all ToolTip text currently associated with the ToolTip component.

SetToolTip(Control, String)

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

Show(String, IWin32Window)

指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントをモーダルとして表示します。Sets the ToolTip text associated with the specified control, and displays the ToolTip modally.

Show(String, IWin32Window, Int32)

指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した時間だけ表示します。Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration.

Show(String, IWin32Window, Int32, Int32)

指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した相対位置にモーダルとして表示します。Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position.

Show(String, IWin32Window, Int32, Int32, Int32)

指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した相対位置に指定した時間だけ表示します。Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position.

Show(String, IWin32Window, Point)

指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した相対位置にモーダルとして表示します。Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position.

Show(String, IWin32Window, Point, Int32)

指定したコントロールに関連付けられるツールヒント テキストを設定し、そのツールヒントを指定した相対位置に指定した時間だけ表示します。Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position.

StopTimer()

表示されたツールヒントを非表示にするタイマーを停止します。Stops the timer that hides displayed ToolTips.

ToString()

このコントロールの文字列形式を返します。Returns a string representation for this control.

イベント

Disposed

Dispose() メソッドの呼び出しによってコンポーネントが破棄されると発生します。Occurs when the component is disposed by a call to the Dispose() method.

(継承元 Component)
Draw

ツールヒントが描画され、OwnerDraw プロパティが true に設定され、IsBalloon プロパティが false に設定されているときに発生します。Occurs when the ToolTip is drawn and the OwnerDraw property is set to true and the IsBalloon property is false.

Popup

ツールヒントが最初に表示される前に発生します。Occurs before a ToolTip is initially displayed. これは、ToolTip クラスの既定のイベントです。This is the default event for the ToolTip class.

適用対象

こちらもご覧ください