System.Classes.THintEvent

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

THintEvent = procedure(var HintStr: string; var CanShow: Boolean) of object;

C++

typedef void __fastcall (__closure *THintEvent)(System::UnicodeString &HintStr, bool &CanShow);

Properties

Type Visibility Source Unit Parent
type
typedef
public
System.Classes.pas
System.Classes.hpp
System.Classes System.Classes

Description

THintEvent is the method pointer type used to define OnHint events.

Event handlers of the THintEvent type have the following parameters:

Parameter Description
HintStr

The string that will appear in the pop-up help hint. The event handler can change this string to change the hint that appears to the user.

CanShow

Indicates whether the hint specified by HintStr should be shown using the default popup window after the event handler exits. Set this to False to suppress the default behavior when the event handler displays the hint.

See Also