キーボード イベント

次のキーボード イベントは、ハードウェア キーボードとタッチ キーボードの両方で発生します。

UI のコントロールに入力フォーカスがあるときにだけ、キーボード イベントが生成されます。 個々のコントロールは、ユーザーがレイアウト上でコントロールを直接クリックまたはタップするか、Tab キーを使ってコンテンツ領域内のタブ順に入ると、フォーカスを取得します。

コントロールの Focus メソッドを呼び出して、フォーカスを適用することもできます。 これは、UI が読み込まれたときに既定ではキーボード フォーカスが設定されないため、ショートカット キーを実装する場合に必要です。 詳しくは、このトピックの「ショートカット キーの例」をご覧ください。

コントロールが入力フォーカスを受け取るには、コントロールが有効にされ、表示されている必要があります。また、IsTabStop プロパティ値と HitTestVisible プロパティ値が true に設定されている必要もあります。 これは、ほとんどのコントロールの既定の状態です。 コントロールに入力フォーカスがあると、このトピックで後ほど説明するように、キーボード入力イベントを発生させ、応答することもできます。 また、GotFocus イベントと LostFocus イベントを処理して、フォーカスを受け取るコントロールやフォーカスを失うコントロールに応答することもできます。

既定では、コントロールのタブ順は、Extensible Application Markup Language (XAML) 内の出現順になっています。 ただし、TabIndex プロパティを使って、この順序を変更できます。 詳しくは、「キーボード アクセシビリティの実装」をご覧ください。

入力イベント ハンドラーは、次の情報を提供するデリゲートを実装します。

• イベントの送信元。 センダーは、イベント ハンドラーがアタッチされているオブジェクトを報告します。
• イベント データ。 キーボード イベントの場合、イベント データは KeyRoutedEventArgs のインスタンスです。 ハンドラーのデリゲートは KeyEventHandler です。 ハンドラーに関するほとんどのシナリオで、最もよく使われる KeyRoutedEventArgs のプロパティは、Key です。場合によっては、KeyStatus も使われます。
• OriginalSource。 キーボード イベントはルーティング イベントであるため、イベント データには OriginalSource があります。 イベントがオブジェクト ツリーをバブルアップするように意図的に設定した場合、OriginalSource がセンダーではなく対象のオブジェクトとなる場合があります。 ただし、この動作は設計によって異なります。 センダーではなく OriginalSource を使う方法について詳しくは、このトピックの「キーボード ルーティング イベント」または「イベントとルーティング イベントの概要」をご覧ください。

イベントがメンバーとして含まれているオブジェクトに対して、キーボード イベント ハンドラー関数をアタッチできます。 UIElement 派生クラスにもアタッチできます。 XAML で Grid の KeyUp イベントのハンドラーをアタッチする方法を次の例に示します。

<Grid KeyUp="Grid_KeyUp">
  ...
</Grid>

コードを使ってイベント ハンドラーをアタッチすることもできます。 詳しくは、「イベントとルーティング イベントの概要」をご覧ください。

次の例は、前の例でアタッチした KeyUp イベント ハンドラーの定義の一部です。

void Grid_KeyUp(object sender, KeyRoutedEventArgs e)
{
    //handling code here
}

Private Sub Grid_KeyUp(ByVal sender As Object, ByVal e As KeyRoutedEventArgs)
    ' handling code here
End Sub

void MyProject::MainPage::Grid_KeyUp(
  Platform::Object^ sender,
  Windows::UI::Xaml::Input::KeyRoutedEventArgs^ e)
  {
      //handling code here
  }

キーボード イベントはいずれもイベント データに KeyRoutedEventArgs を使います。KeyRoutedEventArgs には次のプロパティがあります。

• キー
• KeyStatus
• Handled
• OriginalSource (RoutedEventArgs から継承)

キーが押されると、KeyDown イベントが発生します。 同様に、キーが離されると、KeyUp イベントが発生します。 通常、特定のキー値を処理するにはイベントをリッスンします。 押されたキーまたは離されたキーを特定するには、イベント データの Key 値を調べます。 Key は VirtualKey 値を返します。 VirtualKey 列挙体には、サポートされているすべてのキーが含まれています。

修飾キーは、Ctrl、Shift など、一般的に他のキーと組み合わせて押されるキーです。 アプリでは、これらの組み合わせをカスタム キーボード ショートカットとして使って、アプリ コマンドを呼び出すことができます。

KeyDown や KeyUp イベント ハンドラーでショートカット キーの組み合わせを検出できます。 修飾キー以外のキーのキーボード イベントが発生した場合は、修飾キーが押された状態になっているかどうかを確認することができます。

または、CoreWindow の GetKeyState() 関数 (CoreWindow.GetForCurrentThread() から取得) は、非修飾キーが押されたときに、修飾子の状態を確認するためにも使用できます。

次の例では、この 2 番目のメソッドを実装していますが、最初の実装のスタブ コードも含まれています。

カスタム ショートカット キーのセットを実装する方法を次の例で示します。 この例では、ユーザーは [Play]、[Pause]、[Stop] の各ボタンまたは Ctrl + P、Ctrl + A、Ctrl + S の各キーボード ショートカットを使って、メディアの再生を制御できます。 ボタンの XAML では、ボタン ラベルのヒントや AutomationProperties プロパティを使って、ショートカット キーを示します。 このアプリ内の説明は、アプリの操作性とアクセシビリティを向上させるために重要です。 詳しくは、「キーボードのアクセシビリティ」をご覧ください。

ページが読み込まれるときに、入力フォーカスをページそのものに設定していることにも注目してください。 この手順を実行しなければ、最初の入力フォーカスがどのコントロールにも設定されず、ユーザーが手動で入力フォーカスを設定する (Tab キーを使ってコントロールを選ぶ、コントロールをクリックするなど) までアプリで入力イベントが発生しません。

<Grid KeyDown="Grid_KeyDown">

  <Grid.RowDefinitions>
    <RowDefinition Height="Auto" />
    <RowDefinition Height="Auto" />
  </Grid.RowDefinitions>

  <MediaElement x:Name="DemoMovie" Source="xbox.wmv"
    Width="500" Height="500" Margin="20" HorizontalAlignment="Center" />

  <StackPanel Grid.Row="1" Margin="10"
    Orientation="Horizontal" HorizontalAlignment="Center">

    <Button x:Name="PlayButton" Click="MediaButton_Click"
      ToolTipService.ToolTip="Shortcut key: Ctrl+P"
      AutomationProperties.AcceleratorKey="Control P">
      <TextBlock>Play</TextBlock>
    </Button>

    <Button x:Name="PauseButton" Click="MediaButton_Click"
      ToolTipService.ToolTip="Shortcut key: Ctrl+A"
      AutomationProperties.AcceleratorKey="Control A">
      <TextBlock>Pause</TextBlock>
    </Button>

    <Button x:Name="StopButton" Click="MediaButton_Click"
      ToolTipService.ToolTip="Shortcut key: Ctrl+S"
      AutomationProperties.AcceleratorKey="Control S">
      <TextBlock>Stop</TextBlock>
    </Button>

  </StackPanel>

</Grid>

//showing implementations but not header definitions
void MainPage::OnNavigatedTo(NavigationEventArgs^ e)
{
    (void) e;    // Unused parameter
    this->Loaded+=ref new RoutedEventHandler(this,&MainPage::ProgrammaticFocus);
}
void MainPage::ProgrammaticFocus(Object^ sender, RoutedEventArgs^ e) 
{
    this->Focus(Windows::UI::Xaml::FocusState::Programmatic);
}

void KeyboardSupport::MainPage::MediaButton_Click(Platform::Object^ sender, Windows::UI::Xaml::RoutedEventArgs^ e)
{
    FrameworkElement^ fe = safe_cast<FrameworkElement^>(sender);
    if (fe->Name == "PlayButton") {DemoMovie->Play();}
    if (fe->Name == "PauseButton") {DemoMovie->Pause();}
    if (fe->Name == "StopButton") {DemoMovie->Stop();}
}


bool KeyboardSupport::MainPage::IsCtrlKeyPressed()
{
    auto ctrlState = CoreWindow::GetForCurrentThread()->GetKeyState(VirtualKey::Control);
    return (ctrlState & CoreVirtualKeyStates::Down) == CoreVirtualKeyStates::Down;
}

void KeyboardSupport::MainPage::Grid_KeyDown(Platform::Object^ sender, Windows::UI::Xaml::Input::KeyRoutedEventArgs^ e)
{
    if (e->Key == VirtualKey::Control) isCtrlKeyPressed = true;
}


void KeyboardSupport::MainPage::Grid_KeyUp(Platform::Object^ sender, Windows::UI::Xaml::Input::KeyRoutedEventArgs^ e)
{
    if (IsCtrlKeyPressed()) 
    {
        if (e->Key==VirtualKey::P) { DemoMovie->Play(); }
        if (e->Key==VirtualKey::A) { DemoMovie->Pause(); }
        if (e->Key==VirtualKey::S) { DemoMovie->Stop(); }
    }
}

protected override void OnNavigatedTo(NavigationEventArgs e)
{
    // Set the input focus to ensure that keyboard events are raised.
    this.Loaded += delegate { this.Focus(FocusState.Programmatic); };
}

private void MediaButton_Click(object sender, RoutedEventArgs e)
{
    switch ((sender as Button).Name)
    {
        case "PlayButton": DemoMovie.Play(); break;
        case "PauseButton": DemoMovie.Pause(); break;
        case "StopButton": DemoMovie.Stop(); break;
    }
}

private static bool IsCtrlKeyPressed()
{
    var ctrlState = CoreWindow.GetForCurrentThread().GetKeyState(VirtualKey.Control);
    return (ctrlState & CoreVirtualKeyStates.Down) == CoreVirtualKeyStates.Down;
}

private void Grid_KeyDown(object sender, KeyRoutedEventArgs e)
{
    if (IsCtrlKeyPressed())
    {
        switch (e.Key)
        {
            case VirtualKey.P: DemoMovie.Play(); break;
            case VirtualKey.A: DemoMovie.Pause(); break;
            case VirtualKey.S: DemoMovie.Stop(); break;
        }
    }
}

Private isCtrlKeyPressed As Boolean
Protected Overrides Sub OnNavigatedTo(e As Navigation.NavigationEventArgs)

End Sub

Private Function IsCtrlKeyPressed As Boolean
    Dim ctrlState As CoreVirtualKeyStates = CoreWindow.GetForCurrentThread().GetKeyState(VirtualKey.Control);
    Return (ctrlState & CoreVirtualKeyStates.Down) == CoreVirtualKeyStates.Down;
End Function

Private Sub Grid_KeyDown(sender As Object, e As KeyRoutedEventArgs)
    If IsCtrlKeyPressed() Then
        Select Case e.Key
            Case Windows.System.VirtualKey.P
                DemoMovie.Play()
            Case Windows.System.VirtualKey.A
                DemoMovie.Pause()
            Case Windows.System.VirtualKey.S
                DemoMovie.Stop()
        End Select
    End If
End Sub

Private Sub MediaButton_Click(sender As Object, e As RoutedEventArgs)
    Dim fe As FrameworkElement = CType(sender, FrameworkElement)
    Select Case fe.Name
        Case "PlayButton"
            DemoMovie.Play()
        Case "PauseButton"
            DemoMovie.Pause()
        Case "StopButton"
            DemoMovie.Stop()
    End Select
End Sub

KeyDown や、KeyUp などの特定のイベントがルーティング イベントです。 ルーティング イベントでは、バブル ルーティング方式が採用されています。 バブル ルーティング方式では、子オブジェクトで発生したイベントが、オブジェクト ツリー内で上位にある親オブジェクトに順にルーティング (バブルアップ) されます。 つまり、同じイベントを処理し、同じイベント データを操作する機会が増えることを意味します。

次の XAML の例では、1 つの Canvas と 2 つの Button オブジェクトについて、KeyUp イベントを処理します。 この場合、どちらかの Button オブジェクトにフォーカスがある間にキーを離すと、KeyUp イベントが発生します。 イベントはその後、親 Canvas までバブルアップされます。

<StackPanel KeyUp="StackPanel_KeyUp">
  <Button Name="ButtonA" Content="Button A"/>
  <Button Name="ButtonB" Content="Button B"/>
  <TextBlock Name="statusTextBlock"/>
</StackPanel>

次の例は、前に示した XAML コンテンツに対応する KeyUp イベント ハンドラーの実装方法を示しています。

void StackPanel_KeyUp(object sender, KeyRoutedEventArgs e)
{
    statusTextBlock.Text = String.Format(
        "The key {0} was pressed while focus was on {1}",
        e.Key.ToString(), (e.OriginalSource as FrameworkElement).Name);
}

このハンドラーで OriginalSource プロパティが使われていることに注意してください。 この例では、OriginalSource がイベントの発生元のオブジェクトを報告します。 StackPanel はコントロールではなく、フォーカスを受け取ることもできないため、StackPanel がこのオブジェクトになることはありません。 StackPanel 内の 2 つのボタンのどちらか 1 つのみがイベントの発生元である可能性がありますが、発生元を調べるにはどうすればよいでしょうか。 親オブジェクトのイベントを処理する場合は、OriginalSource を使って、実際のイベント ソース オブジェクトを判別します。

イベント処理の方針によっては、1 つのイベント ハンドラーだけがバブル イベントに応答するようにした方がよい場合もあります。 たとえば、Button コントロールの 1 つに、特定の KeyUp ハンドラーをアタッチすると、最初にそのイベントを処理するのは、このハンドラーがアタッチされたコントロールになります。 このとき、親パネルではイベントが処理されないようにします。 このようなシナリオでは、イベント データ内の Handled プロパティを使います。

ルーティング イベント データ クラスの Handled プロパティは、イベント ルート上で先に登録された別のハンドラーが既に処理を実行したことを示すためのプロパティで、 ルーティング イベント システムの動作に影響します。 イベント ハンドラー内で Handled を true に設定すると、そのイベントのルーティングはそこで終了し、上位の親要素にイベントは送信されません。

特殊な方法を利用して、既に処理済みとしてマークされているイベントに対して処理を実行できるハンドラーをアタッチすることができます。 この方法では、XAML 属性や、ハンドラーを追加するための言語固有の構文 (C# の場合は +=) を使わずに、AddHandler メソッドを使ってハンドラーを登録します。

この手法の一般的な制限は、 AddHandler API が RoutedEvent 型のパラメーターを受け取り 問題のルーティング イベントを識別することです。 一部のルーティング イベントには RoutedEvent 識別子がないため、Handled の状態でも処理できるルーティング イベントを識別する場合に考慮する必要があります。 UIElement の KeyDown イベントと KeyUp イベントには、ルーティング イベント識別子 (KeyDownEvent と KeyUpEvent) があります。 これに対し、TextBox.TextChanged などのイベントにはルーティング イベント識別子がないため、AddHandler を使う手法には利用できません。

特定のコントロールのキー イベント (たとえば GridView など) をオーバーライドして、キーボードとゲームパッドを含むさまざまな入力デバイスに一貫したフォーカス ナビゲーションを提供できます。

次の例では、コントロールをサブクラス化して KeyDown 動作をオーバーライドし、矢印キーが押されたときにフォーカスを GridView のコンテンツに移動します。

  public class CustomGridView : GridView
  {
    protected override void OnKeyDown(KeyRoutedEventArgs e)
    {
      // Override arrow key behaviors.
      if (e.Key != Windows.System.VirtualKey.Left && e.Key !=
        Windows.System.VirtualKey.Right && e.Key !=
          Windows.System.VirtualKey.Down && e.Key !=
            Windows.System.VirtualKey.Up)
              base.OnKeyDown(e);
      else
        FocusManager.TryMoveFocus(FocusNavigationDirection.Down);
    }
  }

ごく一部の UI 要素では、コマンド実行が組み込みでサポートされています。 コマンド実行の基になる実装では、入力に関連するルーティング イベントを使います。 この方法では、1 つのコマンド ハンドラーを呼び出して、特定のポインター操作、特定のショートカット キーなどの関連する UI 入力を処理できます。

UI 要素でコマンド実行を使うことができる場合は、個々の入力イベントではなく、コマンド実行 API を使うことを検討してください。 詳しくは、「ButtonBase.Command」をご覧ください。

ICommand を実装して、通常のイベント ハンドラーから呼び出すコマンド機能をカプセル化することもできます。 この方法では、Command プロパティを利用できない場合でも、コマンド実行を使うことができます。

キーボード イベントに固有の処理で対応するコントロールもあります。 たとえば、TextBox は、キーボードを使って入力されたテキストをキャプチャし、表示するためのコントロールです。 このコントロールでは、キーボード操作をキャプチャするために、固有のロジックで KeyUp と KeyDown が使われます。また、テキストが実際に変化した場合には、固有の TextChanged イベントを発生させます。

また、TextBox などのテキスト入力の処理を目的としたコントロールに、KeyUp や KeyDown のハンドラーを追加することも通常どおりできます。 ただし、コントロールは、その設計上、キー イベントを通じて伝達されたすべてのキー値に応答するわけではありません。 動作はコントロールによって異なります。

たとえば、ButtonBase (Button の基底クラス) では、Space キーや Enter キーの操作を確認するために KeyUp が処理されます。 ButtonBase では KeyUp を、Click イベントを発生させるマウスの左ボタンを押す操作と同等と見なします。 このイベント処理は、ButtonBase が仮想メソッド OnKeyUp をオーバーライドする際に実現されます。 この実装では、Handled が true に設定されます。 このため、あるボタンの親がキー イベント (たとえば Space バー) をリッスンしていても、既に処理されたイベントをハンドラーで受け取ることはありません。

別の例としては、TextBox があります。 方向キーなどの一部のキーは TextBox ではテキストと見なされず、コントロール UI 動作に固有のキーと見なされます。 TextBox は、これらのイベント ケースを処理済みとしてマークします。

カスタム コントロールで OnKeyDown / OnKeyUp をオーバーライドすると、キー イベントに対する同様のオーバーライド動作を独自に実装できます。 カスタム コントロールで特定のショートカット キーを処理する場合、または TextBox の説明で示したシナリオのようなコントロールの動作またはフォーカスの動作を使う場合、OnKeyDown / OnKeyUp のオーバーライドにこのロジックを組み込む必要があります。

テキスト入力コントロールでは、タッチ キーボードが自動的にサポートされます。 ユーザーがタッチ入力を使って、テキスト コントロールに入力フォーカスを設定すると、タッチ キーボードが自動的に表示されます。 入力フォーカスがテキスト コントロールにないときには、タッチ キーボードが表示されません。

タッチ キーボードが表示されると、フォーカスがある要素をユーザーが見ることができるように、UI が自動的に再配置されます。 この場合、他の重要な UI 領域が画面の表示領域外に移動することがあります。 ただし、タッチ キーボードが表示されたときの既定の動作を無効にして、独自に UI を調整することができます。 詳しくは、タッチ キーボードのサンプルをご覧ください。

テキスト入力を必要とするカスタム コントロールを、標準のテキスト入力コントロールからの派生コントロールとして作成しない場合は、適切な UI オートメーション コントロール パターンを実装してタッチ キーボードを追加し、サポートできます。 詳しくは、タッチ キーボードのサンプルをご覧ください。

タッチ キーボードのキーが押されると、ハードウェア キーボードのキーが押されたとき同様に、KeyDown イベントと KeyUp イベントが発生します。 ただし、タッチ キーボードでは、Ctrl + A、Ctrl + Z、Ctrl + X、Ctrl + C、Ctrl + V に対応する入力イベントは発生しません。これらは、入力コントロールでテキストを操作するために予約されています。

ユーザーが入力すると予想されるデータの種類と一致するようにテキスト コントロールの入力値の種類を設定することで、ユーザーがより速く簡単にアプリにデータを入力できるようになります。 入力値の種類は、コントロールが予期しているテキスト入力の種類のヒントとなるため、システムが、その入力の種類用の特殊なタッチ キーボード レイアウトを提供できます。 たとえば、テキスト ボックスが 4 桁の PIN の入力専用の場合は、InputScope プロパティを Number に設定します。 これにより、システムに数字キーパッド レイアウトの表示が指示されるため、ユーザーは簡単に PIN を入力できます。 詳しくは、「入力値の種類を使ったタッチ キーボードの変更」をご覧ください。

• キーボード操作
• 入力デバイスの識別
• タッチ キーボードの表示への応答

• キーボードの設計ガイドライン

• タッチ キーボードのサンプル
• 基本的な入力のサンプル
• 待機時間が短い入力のサンプル
• フォーカスの視覚効果のサンプル

• 入力サンプル
• 入力: デバイス機能のサンプルに関するページ
• 入力: タッチ キーボードのサンプルに関するページ
• スクリーン キーボードを表示したときの対応のサンプルのページ
• XAML テキスト編集のサンプルに関するページ