Sign in Join
FPDoc Onlineexperiment

TApplication.Hint property

Member of TApplicationpublicIn unit Forms

The current Hint text active for the application.

Declaration

pascal
property Hint: string read FHint write SetHint;

Description

A hint is a String with a pop-up message that appears briefly while the mouse is hovered over a control. It usually displays useful information about how to use the UI element, or the type of data that should be entered, etc.

The property value is normally provided by the Hint text assigned to a control when ShowHint is set to True (for both the control and the application). If the Hint text for the control has short and long variants, the long variant is used in TApplication. Otherwise, the short variant is used for the property value. See TControl.Hint for more information about short and long hints.

Changing the property value causes an assigned OnHint handler to be signalled, along with any other application handlers using the ahtHint type. One of the handlers can be used to override the value for the Hint property. If OnHint (or other handlers) are not assigned, a TCustomHintAction is created and executed to get the value for the Hint property. OnActionExecute can then be used to intercept and fulfill the request for Hint text.

Other properties can be used to customize the delay before a Hint is shown, after the mouse is moved away from the control or form, and how long it will remain visible. See HintPause, HintShortPause, HintHidePause, and HintHidePausePerChar.

Use HintColor to specify the background color used to display the pop-up with the Hint text.

The long variant of the Hint is displayed on the status bar for the active Form when the AutoHint property is enabled for a TStatusBar instance.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.