Vcl.Ribbon.TCustomRibbon.TabHandledKeyTips

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure TabHandledKeyTips(const KeyTip: string; var KeyTips: TKeyTipList);

C++

void __fastcall TabHandledKeyTips(const System::UnicodeString KeyTip, Vcl::Ribbonactnctrls::TKeyTipList* &KeyTips);

Properties

Type Visibility Source Unit Parent
procedure
function
public
Vcl.Ribbon.pas
Vcl.Ribbon.hpp
Vcl.Ribbon TCustomRibbon

Description

Validate KeyTip input when KeyTips State is ktsTabs.

TabHandledKeyTips validates KeyTip input when the KeyTips State is ktsTabs. KeyTips can be in either ktsTabs or ktsControls state. When the KeyTips state is ktsTabs, the user has the option of selecting which Tab to switch to and display the KeyTips for the controls on that tab. When the State ktsTabs, the Application Button and Quick Access Toolbar are also displaying their KeyTips.

The parameters are:

  • KeyTip: The KeyTip the user has input that needs to be validated against.
  • Full: A list of TKeyTipMatchItem that contain details if any KeyTips were matched.

See Also