Vcl.AppEvnts.TCustomApplicationEvents.OnShowHint
Delphi
property OnShowHint: TShowHintEvent read FOnShowHint write FOnShowHint;
C++
__property Vcl::Forms::TShowHintEvent OnShowHint = {read=FOnShowHint, write=FOnShowHint};
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| event | protected | Vcl.AppEvnts.pas Vcl.AppEvnts.hpp |
Vcl.AppEvnts | TCustomApplicationEvents |
Description
Occurs when the application is about to display the hint window for a Help Hint.
Write an OnShowHint event handler to change the appearance and behavior of Help Hints.
The HintStr parameter sets the text of the Help Hint. To obtain the text of a hint for a particular control, call the GetLongHint or GetShortHint function, assigning the result to HintStr. To change the text, change the value of this string.
Use the CanShow parameter to permit or prevent the Help Hint from displaying. If CanShow is true, the Help Hint displays. If it is false, the Help Hint does not appear.
Note: Call the CancelDispatch method from an OnShowHint event handler to prevent the application from forwarding the event to any other application events objects.
See Also
Code Examples