Vcl.Forms.TShowHintEvent
C++
typedef void __fastcall (__closure *TShowHintEvent)(System::UnicodeString &HintStr, bool &CanShow, Vcl::Controls::THintInfo &HintInfo);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| typedef | public | Vcl.Forms.hpp | Vcl.Forms | Vcl.Forms |
Description
TShowHintEvent is the type of the OnShowHint event handler.
TShowHintEvent has the following parameters:
HintStr sets the text of the Help Hint. You can change this string in the event handler to change the hint text that appears to the user.
CanShow indicates whether the Help Hint should display. If the event handler sets CanShow to true, the Help Hint displays. If it sets CanShow to false, the Help Hint does not appear.
HintInfo contains information about the appearance and behavior of the Help window. Change its fields to customize the way the Help Hint is displayed.