Vcl.Controls.THintWindow.ActivateHint
Delphi
procedure ActivateHint(Rect: TRect; const AHint: string); virtual;
C++
virtual void __fastcall ActivateHint(const System::Types::TRect &Rect, const System::UnicodeString AHint);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
procedure function |
public | Vcl.Controls.pas Vcl.Controls.hpp |
Vcl.Controls | THintWindow |
Description
Displays the hint window.
Call ActivateHint to display the hint window at the coordinates provided by the Rect parameter. If the Rect parameter appears off screen, ActivateHint moves the hint window to the closest approximation to the coordinates supplied by Rect that appears entirely on screen. ActivateHint sets the Caption property to the AHint parameter before showing the window, so that the AHint string appears to the user.
After an application displays a hint window, it automatically deactivates it after a time period has elapsed, or when it receives a message that requires hiding the hint message. To hide the hint window that is brought up automatically by the application, use the HideHint method of the global Application object. To hide a hint window that is activated directly by calling ActivateHint, use the ReleaseHandle method.