Vcl.Controls.TControl.Hint

提供: RAD Studio API Documentation
移動先: 案内、 検索

Delphi 

property Hint: string read FHint write FHint stored IsHintStored;

C++ 

__property System::UnicodeString Hint = {read=FHint, write=FHint, stored=IsHintStored};

プロパティ

種類 可視性 ソース ユニット 親
property published
Vcl.Controls.pas
Vcl.Controls.hpp
 Vcl.Controls TControl


説明

Hint は、ユーザーがコントロールにマウス ポインタを合わせたときに表示されるテキスト文字列を含みます。

Hint プロパティを使用すると、ヘルプ ヒント、または特定の場所（ステータス バーなど）のヘルプ テキストとして使用される、ヘルプ テキストの文字列として使用することができます。

ヘルプ ヒントとは、ユーザーがコントロールにマウス ポインタを合わせてしばらく止まった時に表示される、ヘルプ テキストを含む四角形のことです。

ヘルプ ヒントを設定するには

  • ヘルプ ヒントが表示させる各コントロールの Hint プロパティを指定します。
  • 各適切なコントロールの ShowHint プロパティを True に設定するか、すべてのコントロールの ParentShowHint プロパティを True に設定し、フォームの ShowHint プロパティも True に設定します。
  • 実行時に、アプリケーションの ShowHint プロパティの値を True に設定します。
  • ヒントをステータスバーまたは他の場所に表示させるには、アプリケーションの OnHint イベント ハンドラを使用します。 アプリケーションの OnHint イベントは、マウス ポインタがコントロール上に移動した際に発生します。
  • ヒントが、ヘルプ ヒント ボックスと、OnHint イベント ハンドラの両方で使用されるように、|（パイプ）文字で区切られた値で指定します。

次に例を示します。 

 
Edit1.Hint := 'Name|Enter Name in the edit box|1';

 Edit1->Hint = "Name|Enter Name in the edit box|1";

ここでは：

  • Name の部分は、短いヒントで、ヘルプ ヒント ボックスの上部に表示されます。
  • Enter Name in the edit box は、長いヒントで、短いヒントの下に表示されます。 これは GetLongHint 関数で抽出することができ、OnHint イベント ハンドラで使用することができます。
  • 1 は、コントロールの Images プロパティ内にあるイメージ リストのイメージ インデックスで任意です。これは、ヒント内に表示されるイメージのインデックスを示しています。

Hint に値が 1 つしか含まれていない場合、文字列全体がヘルプ ヒントとして使われ、それが GetLongHint や GetShortHint の関数によって返されます。 コントロールに Hint 値が指定されていないが、その親コントロールにはある場合、コントロールは親コントロールの値を使用します（コントロールの ShowHint プロパティが True の場合）。

メモ： アプリケーションの ShowHint プロパティが False の場合、ヘルプ ヒントは表示されませんが、OnHint イベント ハンドラは呼び出されます。

関連項目


コード サンプル

「https://docwiki.embarcadero.com/Libraries/Alexandria/j/index.php?title=Vcl.Controls.TControl.Hint&oldid=586637」から取得