Windows の VisualElement アクセスキー

[アーティクル]
07/13/2023

アクセスキーは、ユーザーがタッチやマウスを使用する代わりにキーボードを介してアプリの目に見える UI をすばやく操作し、操作するための直感的な方法を提供することで、ユニバーサル Windows プラットフォーム (UWP) 上のアプリの使いやすさとアクセシビリティを向上させるキーボードショートカットです。これらは Alt キーと 1 つ以上の英数字キーの組み合わせで、通常は順番に押されます。キーボードショートカットは、1 文字の英数字を使用するアクセスキーに対して自動的にサポートされます。

アクセスキーのヒントは、アクセスキーを含むコントロールの横に表示されるフローティングバッジです。各アクセスキーヒントには、関連付けられているコントロールをアクティブにする英数字キーが含まれています。ユーザーが Alt キーを押すと、アクセスキーのヒントが表示されます。

この UWP プラットフォーム固有のは、のアクセスキー VisualElementを指定するために使用されます。これは XAML で使用されます。添付プロパティをVisualElement.AccessKey英数字の値に設定し、必要に応じて添付プロパティを列挙のAccessKeyPlacement値に設定しVisualElement.AccessKeyVerticalOffset、VisualElement.AccessKeyHorizontalOffset添付プロパティをにdouble、添付プロパティをにdouble設定VisualElement.AccessKeyPlacementします。

<TabbedPage ...
            xmlns:windows="clr-namespace:Xamarin.Forms.PlatformConfiguration.WindowsSpecific;assembly=Xamarin.Forms.Core">
    <ContentPage Title="Page 1"
                 windows:VisualElement.AccessKey="1">
        <StackLayout Margin="20">
            ...
            <Switch windows:VisualElement.AccessKey="A" />
            <Entry Placeholder="Enter text here"
                   windows:VisualElement.AccessKey="B" />
            ...
            <Button Text="Access key F, placement top with offsets"
                    Margin="20"
                    Clicked="OnButtonClicked"
                    windows:VisualElement.AccessKey="F"
                    windows:VisualElement.AccessKeyPlacement="Top"
                    windows:VisualElement.AccessKeyHorizontalOffset="20"
                    windows:VisualElement.AccessKeyVerticalOffset="20" />
            ...
        </StackLayout>
    </ContentPage>
    ...
</TabbedPage>

または、fluent API を使用して C# から使用することもできます。

using Xamarin.Forms.PlatformConfiguration;
using Xamarin.Forms.PlatformConfiguration.WindowsSpecific;
...

var page = new ContentPage { Title = "Page 1" };
page.On<Windows>().SetAccessKey("1");

var switchView = new Switch();
switchView.On<Windows>().SetAccessKey("A");
var entry = new Entry { Placeholder = "Enter text here" };
entry.On<Windows>().SetAccessKey("B");
...

var button4 = new Button { Text = "Access key F, placement top with offsets", Margin = new Thickness(20) };
button4.Clicked += OnButtonClicked;
button4.On<Windows>()
    .SetAccessKey("F")
    .SetAccessKeyPlacement(AccessKeyPlacement.Top)
    .SetAccessKeyHorizontalOffset(20)
    .SetAccessKeyVerticalOffset(20);
...

メソッドはVisualElement.On<Windows>、このプラットフォーム固有のがユニバーサル Windows プラットフォームでのみ実行されるように指定します。名前空間のメソッドはVisualElement.SetAccessKey、のアクセスキー値を設定するために使用されますVisualElement。Xamarin.Forms.PlatformConfiguration.WindowsSpecific メソッドは VisualElement.SetAccessKeyPlacement 、必要に応じて、アクセスキーのヒントを表示するために使用する位置を指定します。列挙では AccessKeyPlacement 、次の値を指定できます。

Auto – アクセスキーヒントの配置がオペレーティングシステムによって決定されることを示します。
Top – アクセスキーのヒントがの上端の上に VisualElement表示されることを示します。
Bottom – アクセスキーのヒントがの下端の下に VisualElement表示されることを示します。
Right – アクセスキーのヒントがの右端 VisualElementの右側に表示されることを示します。
Left – アクセスキーのヒントがの左端 VisualElementの左側に表示されることを示します。
Center – アクセスキーヒントがの中央 VisualElementに重ねて表示されることを示します。

注意

通常、キーヒントの Auto 配置で十分です。これには、アダプティブユーザーインターフェイスのサポートが含まれます。

VisualElement.SetAccessKeyHorizontalOffsetメソッドと VisualElement.SetAccessKeyVerticalOffset メソッドは、アクセスキーのヒントの場所をより詳細に制御するために使用できます。メソッドの SetAccessKeyHorizontalOffset 引数は、アクセスキーヒントを左右に移動する距離を示し、メソッドの SetAccessKeyVerticalOffset 引数はアクセスキーヒントを上下に移動する距離を示します。

注意

アクセスキーの配置がに設定されている場合、アクセスキーヒントのオフセットを設定 Autoできません。

さらに、、GetAccessKeyGetAccessKeyPlacement、GetAccessKeyHorizontalOffset、および GetAccessKeyVerticalOffset の各メソッドを使用して、アクセスキーの値とその場所を取得できます。

その結果、Alt キーを押すと、アクセスキーを定義する VisualElement インスタンスの横にアクセスキーヒントを表示できます。

VisualElement アクセスキープラットフォーム固有

ユーザーがアクセスキーをアクティブにすると、Alt キーを押し、その後にアクセスキーを押すと、の既定の VisualElement アクションが実行されます。たとえば、ユーザーがで Switchアクセスキーをアクティブ化すると、 Switch が切り替えられます。ユーザーがでアクセスキー Entryをアクティブにすると、フォーカスが Entry 取得されます。ユーザーがで Buttonアクセスキーをアクティブ化すると、イベントのイベントハンドラー Clicked が実行されます。

警告

既定では、モーダルダイアログが表示されている場合は、ダイアログの背後にあるページで定義されているアクセスキーをアクティブ化できます。ただし、このシナリオでは、アクセスキーを無効にするためにカスタムロジックを記述できます。これは、UWP プロジェクトのDispatcher.AcceleratorKeyActivatedクラスでイベントをMainPage処理し、イベントハンドラーでモーダルダイアログが表示されるときにイベント引数のプロパティをにtrue設定Handledすることで実現できます。

アクセスキーの詳細については、「アクセスキー」を参照してください。

Windows の VisualElement アクセス キー

関連リンク

その他のリソース

Windows の VisualElement アクセスキー