KeyEventArgs class
TOC
Collapse the table of content
Expand the table of content

KeyEventArgs class

Contains the arguments returned by a virtual key event.

Syntax


public ref class KeyEventArgs sealed : ICoreWindowEventArgs

Members

The KeyEventArgs class has these types of members:

Properties

The KeyEventArgs class has these properties.

PropertyAccess typeDescription

DeviceId

Read-only

Gets a unique ID for the input device that generated this key event.

Handled

Read/write

Gets or sets whether the key press event was handled.

KeyStatus

Read-only

Gets the status of a key at the time the event is fired.

VirtualKey

Read-only

Gets the virtual key that maps to the key that was pressed.

 

Remarks

Windows 10:  

Apps do not receive this event when an Input Method Editor (IME) is enabled. The IME handles all keyboard input and sets Handled to true.

Windows Phone:  

This API is supported in native apps only.

This object is returned by a delegate registered for one of the following events:



// returning keypress events data through KeyEventArgs

void MyCoreWindowEvents::SetWindow( // implementation called by CoreApplication::Run(), provided for context
    _In_ CoreWindow^ window
    )
{
    // ...
    window->KeyDown +=
        ref new TypedEventHandler<CoreWindow^, KeyEventArgs^>(this, &CoreWindowEvents::OnKeyDown);
    window->KeyUp +=
        ref new TypedEventHandler<CoreWindow^, KeyEventArgs^>(this, &CoreWindowEvents::OnKeyUp);

    // ...
   
}


Note  : This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).
 

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Core
Windows::UI::Core [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8

Namespace

Windows.UI.Core
Windows::UI::Core [C++]

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Standard)]
[Version(0x06020000)]
[WebHostHidden()]

See also

Object
ICoreWindowEventArgs
KeyDown
KeyUp

 

 

Show:
© 2016 Microsoft