Method function IGDIPlus.IGPStringFormat.SetHotkeyPrefix(TGPHotkeyPrefix) : TGPStringFormat

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Class: IGPStringFormat

Syntax

Delphi:

function SetHotkeyPrefix( hotkeyPrefix : TGPHotkeyPrefix ) : TGPStringFormat;

C++ Builder:

TGPStringFormat __fastcall SetHotkeyPrefix( TGPHotkeyPrefix hotkeyPrefix );

Visual C++ (MFC):

SetHotkeyPrefix(  hotkeyPrefix );

Summary

Sets the type of processing that is performed on a string when the hot key prefix, an ampersand (&), is encountered.

Description

Call this method to set the type of processing that is performed on a string when the hot key prefix, an ampersand (&), is encountered. The ampersand is called the hot key prefix and can be used to designate certain keys as hot keys. Remarks Hot keys, also called access keys, are keys that are programmed to provide an end user with keyboard shortcuts to functionality and are activated by pressing the ALT key. The keys are application dependent and are identified by an underscored letter, typically in a menu name or menu item; for example, when you press ALT, the letter F of the File menu is underscored. The F key is a shortcut to display the File menu.

A client programmer designates a hot key in an application by using the hot key prefix, an ampersand (&), in a string that typically is displayed as the name of a menu or an item in a menu and by using the SetHotkeyPrefix method to set the appropriate type of processing. When a character in a string is preceded with an ampersand, the key that corresponds to the character becomes a hot key during the processing that occurs when the string is drawn on the display device. The ampersand is called a hot key prefix because it precedes the character to be activated. If HotkeyPrefixNone is passed to SetHotkeyPrefix, no processing of the hot key prefix occurs.

Note The term hot key is used synonymously here with the term access key. The term hot key may have a different meaning in other Windows APIs.