[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'Forms' (#lcl)

TApplication.Hint

The current Hint text active for the application.

Declaration

Source position: forms.pp line 1727

public property TApplication.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

TApplication.ShowHint

  

Indicates if Hints are displayed for the application.

TApplication.OnHint

  

Event handler signalled when a hint is requested in the application.

TApplication.AddOnHintHandler

  

Adds an application Hint handler.

TApplication.OnActionExecute

  

Default handler for unhandled Actions.

TApplication.HintColor

  

The background color for a Hint window.

TApplication.HintPause

  

The delay before a Hint is shown for a form or control.

TApplication.HintShortPause

  

The pause before a different Hint is displayed.

TApplication.HintHidePause

  

Indicates how long a Hint remains visible after the mouse pointer is moved.

TApplication.HintHidePausePerChar

  

Indicates how long a keystroke extends the time a Hint remains visible (added to HintHidePause).

TControl.Hint

  

The text to show in the Hint window for the control.

TControl.ShowHint

  

Enables Hint display for the control.

TControl.ParentShowHint

  

If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.

TStatusBar.AutoHint

  

Indicates if a hint is automatically shown when the mouse hovers over the status bar.


Version 4.0 Generated 2025-05-03 Home