KeyEventArgs Classe

Definição

Namespace:

Windows.UI.Core

Contém os argumentos retornados por um evento de chave virtual.

public ref class KeyEventArgs sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
class KeyEventArgs final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
public sealed class KeyEventArgs

Public NotInheritable Class KeyEventArgs

Herança

Object Platform::Object IInspectable KeyEventArgs

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute

Implementações

ICoreWindowEventArgs

Requisitos do Windows

Família de dispositivos	Windows 10 (introduzida na 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v1.0)

Comentários

Windows 10 Aplicativos não recebem esse evento quando um IME (Editor de Método de Entrada) está habilitado. O IME (Editor de Método de Entrada) manipula todas as entradas de teclado e define Handled como true.

Windows Phone Essa API tem suporte apenas em aplicativos nativos.

Esse objeto é retornado por um delegado registrado para um dos seguintes eventos:

• CoreWindow.KeyDown
• CoreWindow.KeyUp

void SetWindow(CoreWindow const & window)
{
    ...
    window.KeyDown({ this, &App::OnKeyDown });
    window.KeyUp({ this, &App::OnKeyUp });
}

// Keypress data is in KeyEventArgs.
void OnKeyDown(Windows::UI::Core::CoreWindow const& /* sender */,
    Windows::UI::Core::KeyEventArgs const& /* args */) {}

void OnKeyUp(Windows::UI::Core::CoreWindow const& /* sender */,
    Windows::UI::Core::KeyEventArgs const& /* args */) {}

// 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);

    // ...
}

Observação

Essa classe não é ágil, o que significa que você precisa considerar seu modelo de threading e o comportamento de marshaling. Para obter mais informações, consulte Threading e marshaling (C++/CX).

Histórico de versão

Versão do Windows	Versão do SDK	Valor adicionado
1607	14393	deviceId

Propriedades

DeviceId	Obtém uma ID exclusiva para o dispositivo de entrada que gerou esse evento de chave. Use DeviceId para diferenciar entre dispositivos que podem gerar eventos importantes, como vários controladores de jogos. DeviceId não tem suporte para todos os dispositivos de entrada.
Handled	Obtém ou define se o evento de pressionamento de tecla foi manipulado.
KeyStatus	Obtém o status de uma chave no momento em que o evento é acionado.
VirtualKey	Obtém a tecla virtual que é mapeada para a tecla que foi pressionada.

Confira também

• KeyDown
• KeyUp