System.Actions.TContainedAction.DoHint

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

Delphi

function DoHint(var HintStr: string): Boolean; dynamic;

C++

DYNAMIC bool __fastcall DoHint(System::UnicodeString &HintStr);

プロパティ

種類 可視性 ソース ユニット
function public
System.Actions.pas
System.Actions.hpp
System.Actions TContainedAction

説明

OnHint イベント ハンドラを呼び出します。

大抵、アプリケーションは DoHint メソッドを呼び出しません。これは、ユーザーがマウスを、アクションのクライアント コントロールまたはメニュー項目の上に置いた場合に、自動的に呼び出されます。DoHint は、クライアントがヒントの表示を要求すると、アクションのクライアントによって呼び出されます。

DoHint は、OnHint イベント ハンドラをチェックし、イベント ハンドラが存在する場合には、それに HintStr を渡します。OnHint イベント ハンドラは、指定されたヒント文字列 HintStr を変更することができます。DoHint は、イベント ハンドラが割り当てられていない場合、もしくは OnHintTrue を返す場合に、True を返します。

DoHint は、いつヒント テキストを表示させるかを判断するために使用されます。たとえば、Vcl.Controls.TControlActionLink.DoShowHintDoHint を内部的に呼び出し、DoHintTrue を返した場合には、Vcl.Controls.TControlActionLink.DoShowHint はアクションのショートカットの仕様を、表示するヒント テキストに追加します。

関連項目