TApplication.ShowHintWindow

Shows or hides the hint window for a control in the application.

Declaration

Source position: forms.pp line 1580

Arguments

Description

ShowHintWindow performs actions needed to display hint text in a pop-up window for the control represented by the mouse coordinates in the Info argument. No actions are performed in the method if ShowHint has not been enabled, or a valid hint control cannot be determined for the application.

ShowHintWindow maintains an internal THintInfo structure used to store information with the text for the hint, configuration information about its display window, and the control for the hint.

For a valid parented hint control, handler routines are signalled to check whether the hint can be displayed for the application. The OnShowHint event handler(s) are signalled first (when assigned) to determine the hint text or hint data. Additional OnShowHint handlers assigned using AddOnShowHintHandler are signalled next.

If the hint text or hint data was not assigned in the event handlers, the hint text for the hovered control is used. Only the first "|"-delimited line of text in TControl.Hint is used for the hint.

The hint window for the application is created (or re-created) and configured as needed, and the show hint command is performed for the hint control. The ActivateHintData method in the hint window is called to display (or hide) the hint window and activate (or reset) the auto-hide timer.

If the hint control is no longer valid or the hint text is empty, the HideHint method is called to hide an existing hint window.

See also