UIElement.KeyboardAccelerators プロパティ

リファレンス

定義

名前空間:: Windows.UI.Xaml

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

キーボードを使用してアクションを呼び出すキーの組み合わせのコレクションを取得します。

アクセラレータは通常、ボタンまたはメニュー項目に割り当てられます。

さまざまなメニュー項目のキーボードアクセラレータを示すメニューの例

public:
 property IVector<KeyboardAccelerator ^> ^ KeyboardAccelerators { IVector<KeyboardAccelerator ^> ^ get(); };

IVector<KeyboardAccelerator> KeyboardAccelerators();

public IList<KeyboardAccelerator> KeyboardAccelerators { get; }

var iVector = uIElement.keyboardAccelerators;

Public ReadOnly Property KeyboardAccelerators As IList(Of KeyboardAccelerator)

プロパティ値

IVector<KeyboardAccelerator>

IList<KeyboardAccelerator>

KeyboardAccelerator オブジェクトのコレクション。

Windows の要件

デバイスファミリ	Windows 10 Fall Creators Update (10.0.16299.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v5.0 で導入)

例

ここでは、一連のボタンにキーボードアクセラレータを指定します (Button1 のツールヒントを指定します。これにより、既定のキーボードアクセラレータの表示動作がオーバーライドされます)。

<StackPanel x:Name="Container" Grid.Row="0" Background="AliceBlue">
    <Button Content="Button1" Margin="20"
            KeyboardAcceleratorPlacementMode="Auto"
            ToolTipService.ToolTip="Tooltip">
        <Button.KeyboardAccelerators>
            <KeyboardAccelerator  Key="A" Modifiers="Windows"/>
        </Button.KeyboardAccelerators>
    </Button>
    <Button Content="Button2"  Margin="20"
            KeyboardAcceleratorPlacementMode="Auto">
        <Button.KeyboardAccelerators>
            <KeyboardAccelerator  Key="B" Modifiers="Windows"/>
        </Button.KeyboardAccelerators>
    </Button>
    <Button Content="Button3"  Margin="20"
            KeyboardAcceleratorPlacementMode="Auto">
        <Button.KeyboardAccelerators>
            <KeyboardAccelerator  Key="C" Modifiers="Windows"/>
        </Button.KeyboardAccelerators>
    </Button>
</StackPanel>

この例では、MenuFlyoutItem オブジェクトと ToggleMenuFlyoutItem オブジェクトのセットにキーボードアクセラレータを指定します。キーボードアクセラレータがコントロールのポップアップに表示されます。

<AppBarButton AccessKey="R" Icon="Refresh" Label="Refresh" IsAccessKeyScope="True">
    <AppBarButton.Flyout>
        <MenuFlyout>
            <MenuFlyoutItem AccessKey="A" Icon="Refresh" Text="Refresh A">
                <MenuFlyoutItem.KeyboardAccelerators>
                    <KeyboardAccelerator Key="R" Modifiers="Control"/>
                </MenuFlyoutItem.KeyboardAccelerators>
            </MenuFlyoutItem>
            <MenuFlyoutItem AccessKey="B" Icon="Globe" Text="Refresh B" />
            <MenuFlyoutItem AccessKey="C" Icon="Globe" Text="Refresh C" />
            <MenuFlyoutItem AccessKey="D" Icon="Globe" Text="Refresh D" />
            <ToggleMenuFlyoutItem AccessKey="E" Icon="Globe" Text="ToggleMe">
                <MenuFlyoutItem.KeyboardAccelerators>
                    <KeyboardAccelerator Key="Q" Modifiers="Control"/>
                </MenuFlyoutItem.KeyboardAccelerators>
            </ToggleMenuFlyoutItem>
        </MenuFlyout>
    </AppBarButton.Flyout>
</AppBarButton>

表示の動作を制御するには、KeyboardAcceleratorPlacementMode プロパティを使用します。このプロパティは 2 つの値、Auto または Hidden を受け入れます。

<Button Content="Save" Click="OnSave" KeyboardAcceleratorPlacementMode="Auto">
    <Button.KeyboardAccelerators>
        <KeyboardAccelerator Key="S" Modifiers="Control" />
    </Button.KeyboardAccelerators>
</Button>

場合によっては、他の要素 (通常はコンテナーオブジェクト) に関連するヒントを表示する必要があります。たとえば、ピボットヘッダー共に PivotItem のヒントを表示するピボットコントロールがあります。

ここでは、KeyboardAcceleratorPlacementTarget プロパティを使用して、[保存] ボタンのキーボードアクセラレータを構成するキーの組み合わを表示する方法について説明します。この例では、ボタンではなく Grid コンテナーを使用します。

<Grid x:Name="Container" Padding="30">
  <Button Content="Save"
    Click="OnSave"
    KeyboardAcceleratorPlacementMode="Auto"
    KeyboardAcceleratorPlacementTarget="{x:Bind Container}">
    <Button.KeyboardAccelerators>
      <KeyboardAccelerator  Key="S" Modifiers="Control" />
    </Button.KeyboardAccelerators>
  </Button>
</Grid>

注釈

通常、キーボードアクセラレータは UWP アプリケーションの UI で直接説明されるものではありません。ユーザーがフォーカスをコントロールに移動したり、コントロールを長押ししたり、マウスポインターをコントロール上にホバーしたりするときに自動的に表示される、ヒントを使用すると、キーボードアクセラレータが見つけやすくなります。ヒントによって、コントロールにキーボードアクセラレータが関連付けられているかどうかを識別でき、関連付けられている場合は、アクセラレータキーの組み合わせを識別することができます。

Windows 10 バージョン 1703 では、キーボードアクセラレータのショートカットが導入されました。ただし、これらのショートカットは、対応するコントロールの UI では表示されませんでした。

Windows 10 バージョン 1803 以降では、KeyboardAccelerators が宣言されると、コントロールは対応するキーの組み合わせを既定でツールヒントに表示します (MenuFlyoutItem オブジェクトと ToggleMenuFlyoutItem オブジェクトに関連付けられていない限り)。

注意

ツールヒントを指定すると、この動作がオーバーライドされます。

MenuFlyoutItem オブジェクトと ToggleMenuFlyoutItem) オブジェクトの場合、キーボードアクセラレータがポップアップテキストと共に表示されます。

コントロールに複数のアクセラレータが定義されている場合は、最初に登録されたアクセラレータが表示されます。

コントロールに応じて、テキストオーバーライドプロパティを使用して、キーボードアクセラレータに関連付けられている既定のキーの組み合わせ文字列をオーバーライドできます。「MenuFlyoutItem.KeyboardAcceleratorTextOverride」、「AppBarButton.KeyboardAcceleratorTextOverride」、および「AppBarToggleButton.KeyboardAcceleratorTextOverride」を参照してください。

アクセラレータキーには、F1 - F12 や Esc などの 1 つのキー、またはコマンドを呼び出すキーの組み合わせ (Ctrl + Shift + B、または Ctrl C) を指定できます。これらは、通常 Alt キーで変更され、単にコマンドまたはコントロールをアクティブ化するアクセスキー (ニーモニック) とは異なります。

アクセラレータに関連付けられている要素が表示されない場合でも、アクセラレータを実行できます。たとえば、CommandBar の CommandBar.SecondaryCommands コレクション内の項目は、オーバーフローメニューを展開して要素を表示せずにアクセラレータを使用して呼び出すことができます。

既定では、アクセラレータにはグローバルスコープがあります。ただし、 KeyboardAccelerator.ScopeOwner を使用してスコープを制限したり、 KeyboardAccelerator.IsEnabled を使用してアクセラレータを完全に無効にしたりできます。

適用対象

こちらもご覧ください

キーボードアクセラレータ