Vcl.Forms.TApplication.Hint

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

Delphi

property Hint: string read FHint write SetHint;

C++

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

プロパティ

種類 可視性 ソース ユニット
property public
Vcl.Forms.pas
Vcl.Forms.hpp
Vcl.Forms TApplication


説明

ヘルプ ヒント ボックスに表示される、テキスト文字列を示します。

Hint プロパティには、マウスがコントロール上に移動した際にヘルプ ヒント ボックスに現れる、コントロールまたはメニュー項目のヒントの値が格納されています。 ここには、ユーザーにアクションやエラー、その他の情報を提供する、文字列値を割り当てることもできます。 従って、Hint は次の場合に使用します:

  • OnHint イベント ハンドラを使用して、ヒントを、コントロールからステータス バーなどの他の表示領域へ移動させる。 これは、Hint プロパティを読み出します。
  • アプリケーションがアクションを処理している間、そのステータスを表示する。 これは、Hint プロパティを設定します。

ヘルプ ヒントは、OnHint イベントが発生した際に現れます。 このため、TApplicationHint プロパティがステータス バーのキャプションに割り当てられている場合、たとえば、ステータス バー コントロールのそのキャプションは、OnHint イベントの間、Hint プロパティの現在の文字列値を表示します。

Hint 文字列は 2 つの部分 -- 短いと長い -- からなり、| 文字で区切られます。 短いヒントは、ポップアップ ツール ヒントで使用されます。 長いヒントは、ステータス バーで使用されます。 Controls ユニットにあるグローバル関数 GetShortHint および GetLongHint を使用すると、ヒント文字列から、短いヒントと長いヒントをそれぞれ抽出することができます。

メモ: Hint に、アプリケーションで起こっているイベントをユーザーに伝えるメッセージを設定する場合、デフォルトでは、Hint 文字列は、マウス カーソルがコントロール上に移動した時点で、そのコントロールの Hint にリセットされてしまう点に注意してください。

関連項目

コード サンプル