[Windows] Implemented the AutomationPeers to the Border control #27713

Tamilarasan-Paranthaman · 2025-02-11T16:39:15Z

Description of Change

Implemented AutomationPeer support for the Windows Border control.
Added keyboard accessibility by invoking the TapGestureRecognizer when the Enter or Space key is pressed, if a TapGestureRecognizer is attached to the Border.
The Border can now receive focus (IsTabStop = true) only when a TapGestureRecognizer is added, ensuring it behaves like an interactive element.
Accessibility support is implemented using a custom MauiBorderAutomationPeer, derived from FrameworkElementAutomationPeer.
This peer is introduced to support accessibility for the custom MauiBorder implementation, which is built using a Panel. Since Panel does not provide a default AutomationPeer, we explicitly define one (MauiBorderAutomationPeer).

Screenshots

Note: In the following video:

The first Border (containing the CheckBox) does not have a TapGestureRecognizer, so it does not receive focus during keyboard navigation.
The second Border (containing the Label) initially has a TapGestureRecognizer attached. It receives focus as expected, and the Tapped event is correctly fired when pressing the Space or Enter key.
The TapGestureRecognizer is then removed at runtime using the “Remove TapGestureRecognizer” button and added again using the “Add TapGestureRecognizer” button.
After removing it at runtime, the second Border no longer receives focus. Once it is added back, the focus behavior and keyboard interaction work as expected again.

Screen.Recording.mp4

Overridden Core Methods and their Purpose

1. GetAutomationControlTypeCore()

Returns AutomationControlType.Pane, the most appropriate control type for a layout container that doesn't represent a user-interactive control like a button or checkbox.
This helps screen readers and other assistive technologies interpret the element as a structural container, which is typical for layout surfaces like borders and panels.

2. GetClassNameCore()

Returns Panel to reflect the underlying native element.
This helps UI automation tools identify the element’s role, consistent with common patterns in FrameworkElementAutomationPeer.

3. IsControlElementCore()

Returns true to ensure the element is included in the Control View, which represents elements relevant to end users.
This is important for layout elements that serve grouping or logical structuring purposes rather than being purely decorative.

4. IsContentElementCore()

Returns true so the element appears in the Content View, allowing screen readers to expose both this element and its children if they contain user-relevant content.

Issues Fixed

Fixes #27627

jsuarezruiz · 2025-02-12T08:58:27Z

/azp run

azure-pipelines · 2025-02-12T08:58:49Z

Azure Pipelines successfully started running 3 pipeline(s).

Copilot

Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.

Files not reviewed (1)

src/Core/src/PublicAPI/net-windows/PublicAPI.Unshipped.txt: Language not supported

Comments suppressed due to low confidence (2)

src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue27627.cs:7

[nitpick] The class name Issue27627 is not descriptive. Consider renaming it to BorderAutomationPeerTests.

public class Issue27627 : _IssuesUITest

src/Controls/tests/TestCases.HostApp/Issues/Issue27627.cs:19

The test case does not verify the functionality of the MauiBorderAutomationPeer. It only waits for the element with the AutomationId 'TestBorder'. Add a more comprehensive test to verify the functionality of the automation peer.

App.WaitForElement("TestBorder");

jsuarezruiz · 2025-03-20T07:14:39Z

/azp run

azure-pipelines · 2025-03-20T07:14:59Z

Azure Pipelines successfully started running 3 pipeline(s).

mattleibow

Just the typical "we can;t do cool new things in .NET 9".

But, I am super out pf the a11y loop here, so can you just update the PR description with info on what your reasonoing is with the 4 methods in the peer? The Get*Core methods. I see the other 2 peers we have in maui do not have these.

Also, just for confirmation, can you still select elements inside the border via the various a11y nav options - like keyboard and such?

mattleibow · 2025-06-24T20:34:54Z

src/Core/src/Platform/Windows/MauiBorderAutomationPeer.cs

+
+namespace Microsoft.Maui.Platform
+{
+	public class MauiBorderAutomationPeer : FrameworkElementAutomationPeer


This should be internal for .NET 9, and public in .NET 10.

Can you make this internal for now, and then open an issue so we can make it public for .NET 10.

As you suggested, I changed it to internal, created a new issue #30205 to track this change, and included it for reference.

mattleibow · 2025-06-24T20:36:06Z

src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue27627.cs

+		[Category(UITestCategories.Border)]
+		public void VerifyBorderAutomationPeer()
+		{
+			App.WaitForElement("TestBorder");


Before you set the automation peer, is this not possible? I mean, this test appears to be looking for a element with this ID, so I just want to check if the test would fail without this new peer.

Yes, the test failed without the new peer, and it passed after adding it. I have attached the output images for your reference.

Without this peer With this peer

Tamilarasan-Paranthaman · 2025-06-26T12:49:55Z

Just the typical "we can;t do cool new things in .NET 9".

But, I am super out pf the a11y loop here, so can you just update the PR description with info on what your reasonoing is with the 4 methods in the peer? The Get*Core methods. I see the other 2 peers we have in maui do not have these.

Also, just for confirmation, can you still select elements inside the border via the various a11y nav options - like keyboard and such?

@mattleibow, I have updated the PR description with the relevant details. Regarding accessibility navigation, yes, it still allows navigating to the child elements within the Border. For example, if an Entry is placed inside the Border, pressing the Tab key will move focus to the Entry as expected.

PureWeen

The automation peer needs to only activate when a gesture is attached to it.

Similar to how android and ios work where we change the accessibility features.

jsuarezruiz · 2025-10-23T06:47:22Z

/azp run

azure-pipelines · 2025-10-23T06:47:44Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz · 2025-10-23T10:27:18Z

src/Core/src/Platform/Windows/MauiBorderAutomationPeer.cs

+
+		protected override bool IsKeyboardFocusableCore() => true;
+
+		protected override bool IsControlElementCore() => true;


Maybe a comment would be nice here:

Control View: Contains user-interactive borders (with gesture recognizers)

Content View: Allows screen readers to announce border structure

I have added the comments

jsuarezruiz · 2025-10-23T10:30:32Z

src/Controls/tests/TestCases.HostApp/Issues/Issue27627.cs

+	{
+		var grid = new Grid();
+
+		var border = new Border


Could expand the sample to test more scenarios?

Nested Borders. Each gets own automation peer via OnCreateAutomationPeer()

Border with custom Content. IsContentElementCore = true ensures nested content exposed to screen readers

@jsuarezruiz, I have modified the test sample as suggested.

Tamilarasan-Paranthaman · 2025-10-24T15:00:15Z

The automation peer needs to only activate when a gesture is attached to it.

Similar to how android and ios work where we change the accessibility features.

@PureWeen, I have modified the implementation as suggested and updated the details in the PR description.

dotnet-policy-service bot added the community ✨ Community Contribution label Feb 11, 2025

Tamilarasan-Paranthaman added the partner/syncfusion Issues / PR's with Syncfusion collaboration label Feb 11, 2025

jsuarezruiz added platform/windows t/a11y Relates to accessibility labels Feb 12, 2025

PureWeen added the area-controls-border Border label Feb 12, 2025

tj-devel709 self-requested a review February 12, 2025 22:19

PureWeen added the do-not-merge Don't merge this PR label Feb 12, 2025

Tamilarasan-Paranthaman marked this pull request as ready for review February 13, 2025 10:19

Copilot AI review requested due to automatic review settings February 13, 2025 10:19

Tamilarasan-Paranthaman requested a review from a team as a code owner February 13, 2025 10:19

Tamilarasan-Paranthaman requested a review from jfversluis February 13, 2025 10:19

Copilot AI reviewed Feb 13, 2025

View reviewed changes

mattleibow requested changes Jun 24, 2025

View reviewed changes

Tamilarasan-Paranthaman mentioned this pull request Jun 25, 2025

[NET 10.0][Windows] Expose MauiBorderAutomationPeer as public for Border #30205

Open

Tamilarasan-Paranthaman force-pushed the fix-27627 branch from 6402596 to fd4179b Compare June 26, 2025 13:09

PureWeen requested changes Oct 17, 2025

View reviewed changes

Tamilarasan-Paranthaman and others added 4 commits October 18, 2025 01:34

Implemented automation peer for Border

57cdb10

Border automation peer changes

7d9a82c

Added test case.

5d2f86a

Updated MauiBorderAutomationPeer.cs

ef45d50

Tamilarasan-Paranthaman force-pushed the fix-27627 branch from fd4179b to ef45d50 Compare October 17, 2025 20:05

PureWeen added this to the .NET 10 SR1 milestone Oct 18, 2025

PureWeen added the p/0 Work that we can't release without label Oct 18, 2025

PureWeen added this to MAUI SDK Ongoing Oct 18, 2025

github-project-automation bot moved this to Todo in MAUI SDK Ongoing Oct 18, 2025

Copilot AI mentioned this pull request Oct 18, 2025

Add AutomationPeer to Windows Borders for keyboard navigation and accessibility #32068

Draft

Border AutomationPeer changes

d61c0e9

Tamilarasan-Paranthaman force-pushed the fix-27627 branch from da60565 to d61c0e9 Compare October 22, 2025 08:19

Border AutomationPeer changes

85d056c

jsuarezruiz requested changes Oct 23, 2025

View reviewed changes

github-project-automation bot moved this from Todo to Changes Requested in MAUI SDK Ongoing Oct 23, 2025

Maui Borde rAutomationPeer changes

deab159


		protected override bool IsKeyboardFocusableCore() => true;

		protected override bool IsControlElementCore() => true;

[Windows] Implemented the AutomationPeers to the Border control #27713

Are you sure you want to change the base?

[Windows] Implemented the AutomationPeers to the Border control #27713

Conversation

Tamilarasan-Paranthaman commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Screenshots

Overridden Core Methods and their Purpose

Issues Fixed

Uh oh!

jsuarezruiz commented Feb 12, 2025

Uh oh!

azure-pipelines bot commented Feb 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz commented Mar 20, 2025

Uh oh!

azure-pipelines bot commented Mar 20, 2025

Uh oh!

mattleibow left a comment

Choose a reason for hiding this comment

Uh oh!

mattleibow Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

Tamilarasan-Paranthaman Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

mattleibow Jun 24, 2025

Choose a reason for hiding this comment

Uh oh!

Tamilarasan-Paranthaman Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

Tamilarasan-Paranthaman commented Jun 26, 2025

Uh oh!

PureWeen left a comment

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz commented Oct 23, 2025

Uh oh!

azure-pipelines bot commented Oct 23, 2025

Uh oh!

jsuarezruiz Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Tamilarasan-Paranthaman Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz Oct 23, 2025

Choose a reason for hiding this comment

Uh oh!

Tamilarasan-Paranthaman Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Tamilarasan-Paranthaman commented Oct 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Tamilarasan-Paranthaman commented Feb 11, 2025 •

edited

Loading

jsuarezruiz Oct 23, 2025 •

edited

Loading