KeyEventArgs Класс

Определение

Пространство имен:

Windows.UI.Core

Содержит аргументы, возвращаемые событием виртуального ключа.

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

Наследование

Object Platform::Object IInspectable KeyEventArgs

Атрибуты

ContractVersionAttribute MarshalingBehaviorAttribute

Реализации

ICoreWindowEventArgs

Требования к Windows

Семейство устройств	Windows 10 (появилось в 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (появилось в v1.0)

Комментарии

Windows 10 Приложения не получают это событие, если включен редактор метода ввода (IME). Редактор метода ввода (IME) обрабатывает все входные данные с клавиатуры и устанавливает значение Handled в значение true.

Windows Phone Этот API поддерживается только в собственных приложениях.

Этот объект возвращается делегатом, зарегистрированным для одного из следующих событий:

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

    // ...
}

Примечание

Этот класс не является гибким, что означает, что необходимо учитывать его потоковую модель и поведение маршалинга. Дополнительные сведения см. в разделе Потоки и маршалинг (C++/CX)..

Журнал версий

Версия Windows	Версия пакета SDK	Добавленная стоимость
1607	14393	deviceId

Свойства

DeviceId	Получает уникальный идентификатор устройства ввода, создающего это ключевое событие. Используйте DeviceId, чтобы различать устройства, которые могут генерировать ключевые события, например несколько игровых контроллеров. DeviceId поддерживается не для всех устройств ввода.
Handled	Возвращает или задает значение, указывающее, было ли обработано событие нажатия клавиши.
KeyStatus	Возвращает состояние ключа на момент запуска события.
VirtualKey	Возвращает виртуальную клавишу, которая сопоставляется с нажатой клавишей.

См. также раздел

• KeyDown
• KeyUp