AppBarButton.KeyboardAcceleratorTextOverride Propriété

Définition

Obtient ou définit une chaîne qui remplace la chaîne de combinaison de touches par défaut associée à un raccourci clavier.

Exemple de menu montrant les raccourcis clavier pour différents éléments de menu
Exemple de menu montrant les raccourcis clavier pour différents éléments de menu

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 = appBarButton.keyboardAcceleratorTextOverride;
appBarButton.keyboardAcceleratorTextOverride = string;
Public Property KeyboardAcceleratorTextOverride As String

Valeur de propriété

String

Platform::String

winrt::hstring

Chaîne pour remplacer la chaîne de combinaison de touches par défaut. La valeur par défaut est null.

Utilisez un espace unique pour aucun texte.

Configuration requise pour Windows

Famille d’appareils
Windows 10, version 1803 (introduit dans 10.0.17134.0)
API contract
Windows.Foundation.UniversalApiContract (introduit dans v6.0)

Remarques

Windows 10, version 1703, introduit les raccourcis clavier. Toutefois, ces raccourcis n’étaient pas affichés avec l’interface utilisateur de leurs contrôles correspondants.

À compter de Windows 10, version 1803, lorsque les keyboardaccelerators sont déclarés, les contrôles affichent les combinaisons de touches correspondantes par défaut.

Le texte de remplacement ne s’affiche pas si le système ne peut pas détecter un clavier attaché (vous pouvez le case activée vous-même via la propriété KeyboardPresent).

Compatibilité des versions

La propriété KeyboardAcceleratorTextOverride n’est pas disponible avant Windows 10 version 1803. Si le paramètre « version de plateforme minimale » de votre application dans Microsoft Visual Studio est inférieur à la « version introduite » indiquée dans le bloc Configuration requise plus loin dans cette page, vous devez concevoir et tester votre application pour tenir compte de cela. Pour plus d’informations, consultez Code adaptatif de version.

Pour éviter les exceptions lorsque votre application s’exécute sur des versions antérieures de Windows 10, ne définissez pas cette propriété en XAML ou ne l’utilisez pas sans effectuer de case activée d’exécution. Cet exemple montre comment utiliser la classe ApiInformation pour case activée la présence de cette propriété avant de la définir.

<CommandBar x:Name="commandBar1" Loaded="CommandBar_Loaded">
    <AppBarButton x:Name="appBarButtonCut" Icon="Cut" Label="Cut"/>
</CommandBar>
private void CommandBar_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.AppBarButton", "KeyboardAcceleratorTextOverride"))
    {
        appBarButtonCut.KeyboardAcceleratorTextOverride = "Ctrl+C";
    }
}

S’applique à

Voir aussi