UI Automation for W3C Accessible Rich Internet Applications Specification
Websites increase their utility with dynamic content and advanced UI controls supported by technologies like Asynchronous JavaScript and XML (AJAX), DHTML, and JavaScript. However, assistive technologies frequently cannot interact with these complex controls or expose dynamic content to users. Accessible Rich Internet Applications (ARIA) is a W3C technical specification for developing web content and applications so that they are accessible to people with disabilities.
To support the ARIA specification, the Microsoft UI Automation specification enables developers to associate UI Automation AriaRole and AriaProperties attributes with W3C ARIA roles and states, or properties. This helps user applications such as Microsoft Internet Explorer support the ARIA object model in the context of UI Automation while keeping a baseline accessibility object model.
This appendix provides the suggested mapping of W3C information to Microsoft Active Accessibility and UI Automation specifications, leveraging the two new UI Automation properties.
This topic contains the following sections:
- W3C ARIA Role Mapped to Microsoft Active Accessibility and UI Automation
- W3C ARIA States and Properties Mapped to Microsoft Active Accessibility and UI Automation
- Additional Considerations
W3C ARIA Role Mapped to Microsoft Active Accessibility and UI Automation
W3C ARIA roles can map to Microsoft Active Accessibility roles or UI Automation control types. With UI Automation, the original W3C ARIA role may also be supported by the AriaRole property. User agents can offer a localized description of the W3C ARIA role with the UI Automation LocalizedControlType property; however, that is optional. When a localized string is not specified, the system will supply the default LocalizedControlType string. User agents may also offer secondary roles in the AriaRole property by using space as a separator, as defined in the ARIA W3C standard.
W3C ARIA States and Properties Mapped to Microsoft Active Accessibility and UI Automation
W3C ARIA states and properties map to various Microsoft Active Accessibility and UI Automation properties and functions. Most of the ARIA states and properties are supported by the UI Automation AriaProperties property. The exceptions are ARIA properties that take object references (for example, the describedby ARIA property), and ARIA properties that are supported by the accessibility object model. For example, the ARIA activedescendent property is expected to be represented as the element with focus in the accessibility object model. The ARIA owns property should be also reflected in the accessibility object model when it is specified.
AriaProperties is a string property that has a collection of name/value pairs whose delimiters are the equal sign (=) and the semicolon (;), for example, "checked=true;disabled=false". A backslash (\) is used as an escape when these delimiter characters, or a backslash, appear in the values. The provider code can add verification to validate the original ARIA properties in the Document Object Model, but it is not required.
| W3C ARIA States and Properties | Microsoft Active Accessibility Properties | UI Automation Properties | UI Automation AriaProperties Property |
|---|---|---|---|
| activedescendent | STATE_SYSTEM_FOCUSED (accState) | HasKeyboardFocus (a property of the child element that is designated to receive the focus) | n/a |
| atomic | n/a | n/a | atomic |
| busy | STATE_SYSTEM_BUSY (accState) | n/a | busy |
| channel | n/a | n/a | channel |
| checked | STATE_SYSTEM_CHECKED (accState) | ToggleState (Toggle control pattern) | checked |
| controls | n/a | ControllerFor | n/a |
| describedby | n/a | DescribedBy | n/a |
| disabled | STATE_SYSTEM_UNAVAILABLE (accState) | IsEnabled | disabled |
| dropeffect | n/a | n/a | dropeffect |
| expanded | STATE_SYSTEM_COLLAPSED or STATE_SYSTEM_EXPANDED (accState) | ExpandCollapseState (ExpandCollapse control pattern) | expanded |
| flowto | n/a | FlowsTo | n/a |
| grab | n/a | n/a | grab |
| haspopup | STATE_SYSTEM_HASPOPUP (accState) | n/a | haspopup |
| hidden | STATE_SYSTEM_INVISIBLE (accState) | IsOffscreen | hidden |
| invalid | n/a | IsDataValidForForm | invalid |
| labelledby | n/a | LabeledBy | n/a |
| Level | accValue | n/a (represented by automation element tree structure) | level |
| live | n/a | n/a | live |
| multiline | n/a | Document control type | multiline |
| multiselectable | STATE_SYSTEM_EXTSELECTABLE (accState) | CanSelectMultiple (Selection control pattern) | multiselectable |
| owns | n/a (should be reflected in the accessible object tree) | n/a (should be reflected in the automation element tree) | n/a |
| Posinset | n/a (represented in the accessible object tree structure or by childId) | n/a (represented in automation element tree structure) | posinset |
| pressed | STATE_SYSTEM_PRESSED | ToggleState (Toggle control pattern) | pressed |
| readonly | STATE_SYSTEM_READONLY | IsReadOnly | readonly |
| relevant | n/a | n/a | relevant |
| required | n/a | IsRequiredForForm | required |
| secret | STATE_SYSTEM_PROTECTED | IsPassword | secret |
| selected | STATE_SYSTEM_SELECTED | IsSelected (SelectionItem control pattern) | selected |
| setsize | n/a | n/a (child count in automation element tree structure) | setsize |
| sort | n/a | n/a | sort |
| tabindex | STATE_SYSTEM_FOCUSABLE | IsKeyboardFocusable | tabindex |
| valuemax | n/a | Maximum (RangeValue control pattern) | valuemax |
| valuemin | n/a | Minimum (RangeValue control pattern) | valuemin |
| valuenow | IAccessible::get_accValue | Value (RangeValue control pattern) | valuenow |
| valuetext | IAccessible::get_accValue NOTE: When both the valuenow and valuetext ARIA properties are set, accValue holds the data from the ARIA valuetext property. |
Value (Value control pattern) NOTE: The RangeValue and Value control patterns can coexist with UI Automation when both valuetext and valuenow are specified. |
valuetext |
Additional Considerations
UI Automation also offers a simple text object model with the Text control pattern, which supports embedding objects in a Document object. This enables user agents and client applications to treat web content as an HTML document or as a traditional desktop UI, depending on the end-user scenarios.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for