KeyEventArgs Klasse

Definition

Namespace:

Windows.UI.Core

Enthält die Argumente, die von einem virtuellen Schlüsselereignis zurückgegeben werden.

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

Vererbung

Object Platform::Object IInspectable KeyEventArgs

Attribute

ContractVersionAttribute MarshalingBehaviorAttribute

Implementiert

ICoreWindowEventArgs

Windows-Anforderungen

Gerätefamilie	Windows 10 (eingeführt in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v1.0)

Hinweise

Windows 10 Apps erhalten dieses Ereignis nicht, wenn ein Eingabemethoden-Editor (IME) aktiviert ist. Der Eingabemethoden-Editor (IME) verarbeitet alle Tastatureingaben und legt Handled auf true fest.

Windows Phone Diese API wird nur in nativen Apps unterstützt.

Dieses Objekt wird von einem Delegat zurückgegeben, der für eines der folgenden Ereignisse registriert ist:

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

    // ...
}

Hinweis

Diese Klasse ist nicht agil, was bedeutet, dass Sie das Threadingmodell und das Marshallverhalten berücksichtigen müssen. Weitere Informationen finden Sie unter Threading und Marshalling (C++/CX).

Versionsverlauf

Windows-Version	SDK-Version	Wertschöpfung
1607	14393	deviceId

Eigenschaften

DeviceId	Ruft eine eindeutige ID für das Eingabegerät ab, das dieses Schlüsselereignis generiert hat. Verwenden Sie DeviceId, um zwischen Geräten zu unterscheiden, die wichtige Ereignisse generieren können, z. B. mehrere Gamecontroller. DeviceId wird nicht für alle Eingabegeräte unterstützt.
Handled	Ruft ab oder legt fest, ob das Key Press-Ereignis behandelt wurde.
KeyStatus	Ruft die status eines Schlüssels ab, wenn das Ereignis ausgelöst wird.
VirtualKey	Ruft den virtuellen Schlüssel ab, der dem gedrückten Schlüssel zugeordnet ist.

Weitere Informationen

• KeyDown
• KeyUp