言語

AppBarToggleButton.KeyboardAcceleratorTextOverride プロパティ

定義

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

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

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 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";
    }
}

適用対象

こちらもご覧ください