AcceleratorKeyEventArgs
AcceleratorKeyEventArgs
AcceleratorKeyEventArgs
AcceleratorKeyEventArgs
Class
Definition
Provides the arguments returned by an accelerator key event callback.
public : sealed class AcceleratorKeyEventArgs : IAcceleratorKeyEventArgs, IAcceleratorKeyEventArgs2, ICoreWindowEventArgspublic sealed class AcceleratorKeyEventArgs : IAcceleratorKeyEventArgs, IAcceleratorKeyEventArgs2, ICoreWindowEventArgsPublic NotInheritable Class AcceleratorKeyEventArgs Implements IAcceleratorKeyEventArgs, IAcceleratorKeyEventArgs2, ICoreWindowEventArgs// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
Windows 10 Apps do not receive this event when an Input Method Editor (IME) is enabled. The Input Method Editor (IME) handles all keyboard input and sets Handled to true.
Windows Phone This API is supported in native apps only.
Properties
DeviceId DeviceId DeviceId DeviceId
Gets a unique ID for the input device that generated this key event.
Use DeviceId to differentiate between devices that can generate key events, such as multiple Xbox controllers.
DeviceId is not supported for all input devices.
public : PlatForm::String DeviceId { get; }public string DeviceId { get; }Public ReadOnly Property DeviceId As string// This API is not available in Javascript.
- Value
- PlatForm::String string string string
A unique identifier for the input device associated with the key event, or an empty string. The same device can be assigned a different ID each time it is connected.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
This property is useful for retrieving info for a specific user account associated with the input device.
EventType EventType EventType EventType
Gets the type of the accelerator key event that invoked the callback.
public : CoreAcceleratorKeyEventType EventType { get; }public CoreAcceleratorKeyEventType EventType { get; }Public ReadOnly Property EventType As CoreAcceleratorKeyEventType// This API is not available in Javascript.
- Value
- CoreAcceleratorKeyEventType CoreAcceleratorKeyEventType CoreAcceleratorKeyEventType CoreAcceleratorKeyEventType
The type of the accelerator key event that invoked the callback.
Handled Handled Handled Handled
Gets or sets whether the accelerator key event was handled or not.
public : PlatForm::Boolean Handled { get; set; }public bool Handled { get; set; }Public ReadWrite Property Handled As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
True if the accelerator key event has been handled; false if it has not.
Remarks
Windows 10 Apps do not receive this event when an Input Method Editor (IME) is enabled. The Input Method Editor (IME) handles all keyboard input and sets Handled to true.
Windows Phone This API is supported in native apps only.
KeyStatus KeyStatus KeyStatus KeyStatus
Gets the status of the accelerator key for which the event was raised.
public : CorePhysicalKeyStatus KeyStatus { get; }public CorePhysicalKeyStatus KeyStatus { get; }Public ReadOnly Property KeyStatus As CorePhysicalKeyStatus// This API is not available in Javascript.
The status of the accelerator key.
VirtualKey VirtualKey VirtualKey VirtualKey
Gets the virtual key code for the keypress in the accelerator key event.
public : VirtualKey VirtualKey { get; }public VirtualKey VirtualKey { get; }Public ReadOnly Property VirtualKey As VirtualKey// This API is not available in Javascript.
The virtual key code of the key that was pressed.