[Automation] Fire property-changed events when AutomationId changes at runtime - #21374
Conversation
…t runtime
AutomationElementIdentifiers.AutomationIdProperty was missing, so
runtime changes to AutomationProperties.AutomationId never raised
UIA_AutomationPropertyChangedEventId on Windows (or the equivalent
on macOS). UIA clients that subscribe to property changes would
silently receive stale automation IDs.
- Add AutomationIdProperty sentinel to AutomationElementIdentifiers
- Raise the event in ControlAutomationPeer.OwnerPropertyChanged
when AutomationProperties.AutomationIdProperty changes
- Add AutomationIdProperty -> UiaPropertyId.AutomationId to the Win32
AutomationNode.s_propertyMap
- Add AutomationPeer_AutomationId to AvnAutomationProperty (avn.idl)
and wire it in AvnAutomationPeer.s_propertyMap and automation.mm
- Add unit tests covering runtime AutomationId change notifications
|
You can test this PR using the following package version. |
|
Please read the following Contributor License Agreement (CLA). If you agree with the CLA, please reply with the following: Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by AvaloniaUI OÜ and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant AvaloniaUI OÜ, and those who receive the Submission directly b. Patent License. You grant AvaloniaUI OÜ, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to AvaloniaUI OÜ. You agree to notify AvaloniaUI OÜ in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the Republic of Estonia, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and AvaloniaUI OÜ dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
@cla-avalonia agree |
Done. |
HTH! |
…t runtime (AvaloniaUI#21374) AutomationElementIdentifiers.AutomationIdProperty was missing, so runtime changes to AutomationProperties.AutomationId never raised UIA_AutomationPropertyChangedEventId on Windows (or the equivalent on macOS). UIA clients that subscribe to property changes would silently receive stale automation IDs. - Add AutomationIdProperty sentinel to AutomationElementIdentifiers - Raise the event in ControlAutomationPeer.OwnerPropertyChanged when AutomationProperties.AutomationIdProperty changes - Add AutomationIdProperty -> UiaPropertyId.AutomationId to the Win32 AutomationNode.s_propertyMap - Add AutomationPeer_AutomationId to AvnAutomationProperty (avn.idl) and wire it in AvnAutomationPeer.s_propertyMap and automation.mm - Add unit tests covering runtime AutomationId change notifications

Summary
AutomationElementIdentifiers.AutomationIdPropertywas missing, so runtime changes toAutomationProperties.AutomationIdnever raisedUIA_AutomationPropertyChangedEventIdon Windows (or the equivalent on macOS). UIA clients that subscribe to property changes would silently receive stale automation IDs.AutomationIdPropertysentinel toAutomationElementIdentifiers, mirroring the existingNameProperty,ItemStatusProperty, etc.OwnerPropertyChangedinControlAutomationPeerto raise the event whenAutomationProperties.AutomationIdPropertychanges (mirrors the existingItemStatusPropertyhandler at line 301).AutomationIdProperty → UiaPropertyId.AutomationIdtoAutomationNode.s_propertyMap(Windows) soUIA_AutomationPropertyChangedEventIdis fired correctly.AutomationPeer_AutomationIdtoAvnAutomationPropertyinavn.idland wired it inAvnAutomationPeer.s_propertyMapandautomation.mm(macOS — no VoiceOver notification is posted sinceaccessibilityIdentifieris read on-demand).ControlAutomationPeerTests.AutomationIdNotificationscovering the new notification behaviour.Root cause analysis
GetAutomationIdCore()inControlAutomationPeercorrectly readsAutomationProperties.AutomationId ?? Owner.Nameand the Windows UIA bridge correctly maps it toUIA_AutomationIdPropertyIdviaGetPropertyValue. Static lookups (FindElementByAccessibilityId) always worked. The gap was the change notification path: there was noAutomationIdPropertysentinel inAutomationElementIdentifiers, so it could not be added to the platform property maps, and noOwnerPropertyChangedhandler raised the event. Dynamic bindings (e.g. generated IDs inItemTemplate) would silently produce stale IDs for UIA clients watching property changes.Test plan
tests/Avalonia.IntegrationTests.Appium/ButtonTests.cs— all five tests useFindElementByAccessibilityIdvia thex:Namefallback and must continue to resolve correctly.AutomationTests.AutomationId()test passes — verifies explicitAutomationProperties.AutomationIdtakes precedence overx:Name.ControlAutomationPeerTests.AutomationIdNotifications(3 tests) — verifyPropertyChangedfires on the peer whenAutomationProperties.AutomationIdis set at runtime.Avalonia.Nativeon macOS to confirm theavn.idl/automation.mmchanges compile (requires macOS CI).