Namespace: Consultingwerk.Util
Class 
KeyboardHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.KeyboardHelper

Inherits: Progress.Lang.Object

File:KeyboardHelper
Purpose:Provides support for working with .NET Key (board) Values
Syntax:Static methods only, Protected constructor to disallow
instance creation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Oct 22 22:05:48 CEST 2011

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ System.Windows.Forms.Shortcut ShortcutFromAccelerator (character) Translates a Progress MENU-ITEM Accelerator into a .NET System.Windows.Forms.Shortcut enumeration member
+ System.Windows.Forms.Shortcut ShortcutFromKey (Keys) Convert a single special key into a System.Windows.Forms.Shortcut value
+ System.Windows.Forms.Shortcut ShortcutFromKeyCombination (character, character) Convert special key combinations (like ALT-A) into a System.Windows.Forms.Shortcut value
+ System.Windows.Forms.Shortcut ShortcutFromKeyCombination (character, character, character) Convert special key combinations (like ALT-A) into a System.Windows.Forms.Shortcut value
+ CHARACTER SpecialKeyToAblEventLabel (KeyEventArgs) Returns the ABL Keyboard event label for the specified .NET KeyEventArgs
+ CHARACTER SpecialKeyToAblEventLabel (Keys) Returns the ABL Keyboard event label for the specified .NET Keys Enum value

Top Constructor Summary
Options Name Purpose
# KeyboardHelper () Disallow instance creation


Method Detail
Top

PUBLIC System.Windows.Forms.Shortcut ShortcutFromAccelerator (character)
Purpose: Translates a Progress MENU-ITEM Accelerator into a .NET
System.Windows.Forms.Shortcut enumeration member
Notes: This method used to reside in the UltraToolbarsHelper and has been
moved to the Keyboard helper for better reusability
Note, not all possible Progress Accelerators are available/supported
as .NET Shortcuts, http://blog.consultingwerk.de/consultingwerkblog/2011/10/create-custom-shortcuts-not-contained-in-the-system-windows-forms-shortcut-enumeration/

Parameters:
pcAccelerator CHARACTER
The ABL keyboard accelerator
Returns System.Windows.Forms.Shortcut
The System.Windows.Forms.Shortcut value that matches the ABL keyboard accelerator
Top

PUBLIC System.Windows.Forms.Shortcut ShortcutFromKey (Keys)
Purpose: Convert a single special key into a System.Windows.Forms.Shortcut value
Notes: See http://blog.consultingwerk.de/consultingwerkblog/2011/10/create-custom-shortcuts-not-contained-in-the-system-windows-forms-shortcut-enumeration/

Parameters:
poKey System.Windows.Forms.Keys
The System.Windows.Forms.Keys value to convert
Returns System.Windows.Forms.Shortcut
The Shortcut Enum value
Top

PUBLIC System.Windows.Forms.Shortcut ShortcutFromKeyCombination (character, character)
Purpose: Convert special key combinations (like ALT-A) into a
System.Windows.Forms.Shortcut value
Notes: See http://blog.consultingwerk.de/consultingwerkblog/2011/10/create-custom-shortcuts-not-contained-in-the-system-windows-forms-shortcut-enumeration/

Parameters:
pcKey1 CHARACTER
The first ABL key label
pcKey2 CHARACTER
The second ABL key label
Returns System.Windows.Forms.Shortcut
The Shortcut Enum value
Top

PUBLIC System.Windows.Forms.Shortcut ShortcutFromKeyCombination (character, character, character)
Purpose: Convert special key combinations (like ALT-A) into a
System.Windows.Forms.Shortcut value
Notes: See http://blog.consultingwerk.de/consultingwerkblog/2011/10/create-custom-shortcuts-not-contained-in-the-system-windows-forms-shortcut-enumeration/

Parameters:
pcKey1 CHARACTER
The first ABL key label
pcKey2 CHARACTER
The second ABL key label
pcKey3 CHARACTER
The third ABL key label
Returns System.Windows.Forms.Shortcut
The Shortcut Enum value
Top

PUBLIC CHARACTER SpecialKeyToAblEventLabel (KeyEventArgs)
Purpose: Returns the ABL Keyboard event label for the specified .NET KeyEventArgs
Notes:

Parameters:
poEventArgs System.Windows.Forms.KeyEventArgs
The System.Windows.Forms.Keys to translate
Returns CHARACTER
The ABL Keyboard Event Label or ? for an unknown/unmatches key
Top

PUBLIC CHARACTER SpecialKeyToAblEventLabel (Keys)
Purpose: Returns the ABL Keyboard event label for the specified .NET Keys Enum value
Notes:

Parameters:
poKeys System.Windows.Forms.Keys
The System.Windows.Forms.Keys to translate
Returns CHARACTER
The ABL Keyboard Event Label or ? for an unknown/unmatches key


Constructor Detail
Top

PROTECTED KeyboardHelper ()
Purpose: Disallow instance creation
Notes:



©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:46:33