AppBarToggleButton.KeyboardAcceleratorTextOverride プロパティ

リファレンス

定義

名前空間:: Windows.UI.Xaml.Controls

重要

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

編集

キーボードアクセラレータに関連付けられている既定のキーの組み合わせ文字列をオーバーライドする文字列を取得または設定します。

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

public:
 property Platform::String ^ KeyboardAcceleratorTextOverride { Platform::String ^ get(); void set(Platform::String ^ value); };

winrt::hstring KeyboardAcceleratorTextOverride();

void KeyboardAcceleratorTextOverride(winrt::hstring value);

public string KeyboardAcceleratorTextOverride { get; set; }

var string = appBarToggleButton.keyboardAcceleratorTextOverride;
appBarToggleButton.keyboardAcceleratorTextOverride = string;

Public Property KeyboardAcceleratorTextOverride As String

プロパティ値

String

Platform::String

winrt::hstring

既定のキーの組み合わせ文字列を置き換える文字列。既定値は null です。

テキストがない場合は、1 つのスペースを使用します。

Windows の要件

デバイスファミリ	Windows 10, version 1803 (10.0.17134.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v6.0 で導入)

注釈

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

Windows 10 バージョン 1803 以降では、KeyboardAccelerators が宣言されると、コントロールに対応するキーの組み合わせが既定で表示されます。

上書きしたテキストは、取り付けられているキーボードをシステムが検出できない場合は表示されません (取り付けられているキーボードの検出は、KeyboardPresent プロパティを使用して、ご自分で確認することができます)。

バージョンの互換性

KeyboardAcceleratorTextOverride プロパティは、Windows 10 バージョン 1803 より前は使用できません。 Microsoft Visual Studio のアプリの "最小プラットフォームバージョン" 設定が、このページの後半の「要件」ブロックに示されている "導入されたバージョン" より小さい場合は、これを考慮してアプリを設計してテストする必要があります。詳細については、「バージョンアダプティブコード」を参照してください。

以前のバージョンのWindows 10でアプリを実行するときに例外を回避するには、XAML でこのプロパティを設定したり、ランタイムチェックを実行せずに使用したりしないでください。この例では、ApiInformation クラスを使用して、このプロパティを設定する前に、このプロパティの存在をチェックする方法を示します。

<CommandBar x:Name="commandBar1" Loaded="CommandBar_Loaded">
    <AppBarToggleButton x:Name="appBarButtonShuffle" Icon="Shuffle" Label="Shuffle"/>
</CommandBar>

private void CommandBar_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.AppBarToggleButton", "KeyboardAcceleratorTextOverride"))
    {
        appBarButtonCut.KeyboardAcceleratorTextOverride = "Ctrl+S";
    }
}

適用対象

こちらもご覧ください

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

次の方法で共有