FMX.AcceleratorKey.IFMXAcceleratorKeyRegistryService.ExtractAcceleratorKey

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure ExtractAcceleratorKey(const AText: string; out Key: Char; out KeyIndex: Integer);

C++

virtual void __fastcall ExtractAcceleratorKey(const System::UnicodeString AText, /* out */ System::WideChar &Key, /* out */ int &KeyIndex) = 0 ;

Properties

Type Visibility Source Unit Parent
procedure
function
public
FMX.AcceleratorKey.pas
FMX.AcceleratorKey.hpp
FMX.AcceleratorKey IFMXAcceleratorKeyRegistryService

Description

Returns the accelerator character and the position index inside the text string.

ExtractAcceleratorKey processes the AText parameter string to identify any embedded accelerator key marker (the ampersand symbol).

  • If AText contains an accelerator character, Key returns the accelerator character and KeyIndex returns the position of the accelerator character inside the text string.
  • If AText does not contain an acceleration character, Key contains a NULL character and KeyIndex is filled with -1.

See Also