Vcl.Controls.TControlActionLink.DoShowHint

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function DoShowHint(var HintStr: string): Boolean; virtual;

C++

virtual bool __fastcall DoShowHint(System::UnicodeString &HintStr);

Properties

Type Visibility Source Unit Parent
function protected
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls TControlActionLink

Description

Indicates whether the hint is shown or modified.

DoShowHint determines whether a hint is shown when the mouse moves across a control. DoShowHint also provides an opportunity to modify the hint, and/or append a shortcut to the end of the hint string. If either the application, the control, or the action veto showing the hint, then the hint is not shown. DoShowHint returns True by default. You can override this function to return False if the hint is not shown or modified, or if the shortcut is not appended.

See Also