CharacterReceivedEventArgs class

Provides the arguments returned by the event raised when a character is received by the input queue.

Syntax


Public NotInheritable Class CharacterReceivedEventArgs
    Implements ICoreWindowEventArgs

Attributes

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

Members

The CharacterReceivedEventArgs class has these types of members:

Methods

The CharacterReceivedEventArgs class inherits methods from the Object class.

Properties

The CharacterReceivedEventArgs class has these properties.

PropertyAccess typeDescription

Handled

Read/writeGets or sets whether the character-received event was handled or not.

KeyCode

Read-onlyGets the key code of the character whose input raised the event.

KeyStatus

Read-onlyGets the status of the physical key press that raised the character-received event.

 

Remarks

Windows 10 Technical Preview:  

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 the following event:



// returning character received events data through CharacterReceivedEventArgs

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

    // ...
   
}


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 (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

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

See also

Object
ICoreWindowEventArgs
CharacterReceived

 

 

Show:
© 2015 Microsoft