Vcl.Controls.THintWindow.ActivateHintData
Delphi
procedure ActivateHintData(Rect: TRect; const AHint: string; AData: TCustomData); virtual;
C++
virtual void __fastcall ActivateHintData(const System::Types::TRect &Rect, const System::UnicodeString AHint, void * AData);
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
procedure function |
public | Vcl.Controls.pas Vcl.Controls.hpp |
Vcl.Controls | THintWindow |
Description
Displays the hint window using a provided data value.
Call ActivateHintData to display the hint window at the coordinates provided by the Rect parameter. The ActivateHintData method for THintWindow sets the Caption property to the AHint parameter and ignores the AData parameter. Descendant classes can override this method to combine the AHint and AData parameters into a customized Hint value.
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.