starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #11501] [MERGED] Properly initialize XamlUiaTextRange with ProviderFromPeer #28614

New Issue
Open
opened 2026-01-31 09:29:39 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:29:39 +00:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/11501
Author: @carlos-zamora
Created: 10/13/2021
Status: ✅ Merged
Merged: 10/14/2021
Merged by: @undefined

Base: main ← Head: dev/cazamor/a11y/a-tale-of-two-auto-peers

📝 Commits (4)

  • 8b8951b Properly initialize XamlUiaTextRange with ProviderFromPeer
  • b7fa5c7 address DHowett feedback
  • 49e9f41 revert OnCreateAutoPeer change
  • 89a1479 update comment

📊 Changes

6 files changed (+33 additions, -44 deletions)

View changed files

📝 src/cascadia/TerminalControl/InteractivityAutomationPeer.cpp (+25 -15)
📝 src/cascadia/TerminalControl/InteractivityAutomationPeer.h (+4 -0)
📝 src/cascadia/TerminalControl/InteractivityAutomationPeer.idl (+1 -1)
📝 src/cascadia/TerminalControl/TermControlAutomationPeer.cpp (+1 -26)
📝 src/cascadia/TerminalControl/TermControlAutomationPeer.h (+0 -2)
📝 src/cascadia/TerminalControl/XamlUiaTextRange.cpp (+2 -0)

📄 Description

Summary of the Pull Request

As a part of the Interactivity split, TermControlAutomationPeer had to be split into TermControlAutomationPeer (TCAP) and InteractivityAutomationPeer (IAP). Just about all of the functions in InterativityAutomationPeer operate by calling the non-XAML UIA Provider then wrapping the resulting UIATextRange into a XAML format (a XamlUiaTextRange [XUTR]). As a part of that XUTR constructor, we need a reference to the parent provider.

We generally get that via ProviderFromPeer(), but IAP's ProviderFromPeer() returned null (presumably because IAP isn't in the UI tree, whereas TCAP is directly registered as the automation peer for the TermControl).

It looks like some screen readers didn't care (like NVDA, though there may be a chance we just didn't encounter an issue just yet), but Narrator definitely did.

The fix was to provide XUTR constructors the ProviderFromPeer from TCAP, not IAP. To accomplish this, IAP now holds a weak reference to TCAP, and provides the ProviderFromPeer when needed. We can't cache this result because there is no guarantee that it won't change.

Some miscellaneous changes include:

  • TermControl::OnCreateAutomationPeer now returns the existing auto peer instead of always creating a new one
  • TCAP::WrapArrayOfTextRangeProviders was removed as it was unused (normally, this would be directly affected by the main ProviderFromPeer change here)
  • XUTR::GetEnclosingElement is now hooked up to trace logging for debugging purposes

References

Introduced in #10051
Closes #11488

Validation Steps Performed

✅ Narrator scan mode now works (verified with character, word, and line navigation)
✅ NVDA movement still works (verified with word and line navigation)

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/microsoft/terminal/pull/11501 **Author:** [@carlos-zamora](https://github.com/carlos-zamora) **Created:** 10/13/2021 **Status:** ✅ Merged **Merged:** 10/14/2021 **Merged by:** [@undefined](undefined) **Base:** `main` ← **Head:** `dev/cazamor/a11y/a-tale-of-two-auto-peers` --- ### 📝 Commits (4) - [`8b8951b`](https://github.com/microsoft/terminal/commit/8b8951bae8244f9cc6424836359c7707000f1ddd) Properly initialize XamlUiaTextRange with ProviderFromPeer - [`b7fa5c7`](https://github.com/microsoft/terminal/commit/b7fa5c7fd2e1575794616e985283d1348903cade) address DHowett feedback - [`49e9f41`](https://github.com/microsoft/terminal/commit/49e9f4101332a981e9fe51aa10d642157a849778) revert OnCreateAutoPeer change - [`89a1479`](https://github.com/microsoft/terminal/commit/89a14790b727bdfc9da6e71e5e02e8272c75cb5c) update comment ### 📊 Changes **6 files changed** (+33 additions, -44 deletions) <details> <summary>View changed files</summary> 📝 `src/cascadia/TerminalControl/InteractivityAutomationPeer.cpp` (+25 -15) 📝 `src/cascadia/TerminalControl/InteractivityAutomationPeer.h` (+4 -0) 📝 `src/cascadia/TerminalControl/InteractivityAutomationPeer.idl` (+1 -1) 📝 `src/cascadia/TerminalControl/TermControlAutomationPeer.cpp` (+1 -26) 📝 `src/cascadia/TerminalControl/TermControlAutomationPeer.h` (+0 -2) 📝 `src/cascadia/TerminalControl/XamlUiaTextRange.cpp` (+2 -0) </details> ### 📄 Description ## Summary of the Pull Request As a part of the Interactivity split, `TermControlAutomationPeer` had to be split into `TermControlAutomationPeer` (TCAP) and `InteractivityAutomationPeer` (IAP). Just about all of the functions in `InterativityAutomationPeer` operate by calling the non-XAML UIA Provider then wrapping the resulting `UIATextRange` into a XAML format (a `XamlUiaTextRange` [XUTR]). As a part of that XUTR constructor, we need a reference to the parent provider. We generally get that via `ProviderFromPeer()`, but IAP's `ProviderFromPeer()` returned null (presumably because IAP isn't in the UI tree, whereas TCAP is directly registered as the automation peer for the `TermControl`). It looks like some screen readers didn't care (like NVDA, though there may be a chance we just didn't encounter an issue just yet), but Narrator definitely did. The fix was to provide XUTR constructors the `ProviderFromPeer` from TCAP, _not_ IAP. To accomplish this, IAP now holds a weak reference to TCAP, and provides the `ProviderFromPeer` when needed. We can't cache this result because there is no guarantee that it won't change. Some miscellaneous changes include: - `TermControl::OnCreateAutomationPeer` now returns the existing auto peer instead of always creating a new one - `TCAP::WrapArrayOfTextRangeProviders` was removed as it was unused (normally, this would be directly affected by the main `ProviderFromPeer` change here) - `XUTR::GetEnclosingElement` is now hooked up to trace logging for debugging purposes ## References Introduced in #10051 Closes #11488 ## Validation Steps Performed ✅ Narrator scan mode now works (verified with character, word, and line navigation) ✅ NVDA movement still works (verified with word and line navigation) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-31 09:29:39 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#28614
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?