Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Mapping ARIA Roles, States, and Properties to UI Automation

The World Wide Web Consortium (W3C) defines Accessible Rich Internet Applications (ARIA) as a syntax for making dynamic web content and custom user interface (UI) accessible. Windows Internet Explorer 8 recognizes the ARIA role, state, and property information and exposes it to assistive technologies, which in turn can use the Microsoft Active Accessibility and/or Microsoft UI Automation APIs to retrieve the information. Instead of building separate simplified webpages for accessibility, you can use ARIA to mark up your rich web applications with roles, states, and properties. For example, to match the behavior you create through a script, you can define a div element as a button, checkbox, or another ARIA role.

This topic contains the following sections:

W3C ARIA Roles

W3C ARIA roles are mapped to a Microsoft Active Accessibility role or to a UI Automation control type. The original W3C ARIA role can be supported by the UI Automation AriaRole property. Optionally, user agents can also offer localized descriptions of the W3C ARIA role by using the LocalizedControlType property of the UI Automation control. When the localized string is not specified, a default LocalizedControlType string is supplied by the system.

W3C ARIA Role Attribute (Draft 4)Microsoft Active Accessibility accRole Property UI Automation ControlType PropertyUI Automation AriaRole Property
"alert"ROLE_SYSTEM_ALERTTextalert
"alertdialog"ROLE_SYSTEM_DIALOG Windowalertdialog
"application"ROLE_SYSTEM_PANE paneapplication
"button"ROLE_SYSTEM_PUSHBUTTONbuttonbutton
"checkbox"ROLE_SYSTEM_CHECKBUTTONCheckboxcheckbox
"columnheader"ROLE_SYSTEM_COLUMNHEADER DataItemcolumnheader
"combobox"ROLE_SYSTEM_COMBOBOXComboboxcombobox
"description"ROLE_SYSTEM_TEXTTextdescription
"dialog"ROLE_SYSTEM_DIALOG Windowdialog
"directory"ROLE_SYSTEM_LIST Listdirectory
"document"ROLE_SYSTEM_CLIENTDocumentdocument
"grid"ROLE_SYSTEM_TABLEDataGridgrid
"gridcell"ROLE_SYSTEM_CELLDataItemgridcell
"group"ROLE_SYSTEM_GROUPINGGroupinggroup
"heading"ROLE_SYSTEM_TEXTTextheading
"img"ROLE_SYSTEM_GRAPHICImageimg
"link"ROLE_SYSTEM_LINKHyperLinklink
"list"ROLE_SYSTEM_LISTListlist
"listbox"ROLE_SYSTEM_LISTListlistbox
"listitem"ROLE_SYSTEM_LISTITEMListItemlistitem
"log"ROLE_SYSTEM_PANEPanelog
"marquee"ROLE_SYSTEM_ANIMATIONTextmarquee
"menu"ROLE_SYSTEM_MENUPOPUPMenumenu
"menubar"ROLE_SYSTEM_MENUBARMenuBarmenubar
"menuitem"ROLE_SYSTEM_MENUITEMMenuItemmenuitem
"menuitemcheckbox"ROLE_SYSTEM_CHECKBUTTONCheckBoxmenuitemcheckbox
"menuitemradio"ROLE_SYSTEM_RADIOBUTTONRadioButtonmenuitemradio
"option"ROLE_SYSTEM_LISTITEMListItemoption
"presentation"ROLE_SYSTEM_PANEPanepresentation
"progressbar"ROLE_SYSTEM_PROGRESSBARProgressBarprogressbar
"radio"ROLE_SYSTEM_RADIOBUTTONRadioButtonradio
"radiogroup"ROLE_SYSTEM_GROUPINGGroupradiogroup
"region"ROLE_SYSTEM_PANEPaneregion
"row"ROLE_SYSTEM_ROWDataItemrow
"rowheader"ROLE_SYSTEM_ROWHEADERDataItemrowheader
"separator"ROLE_SYSTEM_SEPARATORSeparatorseparator
"slider"ROLE_SYSTEM_SLIDERSliderslider
"spinbutton"ROLE_SYSTEM_SPINBUTTONSpinnerspinbutton
"status"ROLE_SYSTEM_STATUSBARStatus Barstatus
"tab"ROLE_SYSTEM_PAGETAB TabItemtab
"tablist"ROLE_SYSTEM_PAGETABLIST Tabtablist
"tabpanel"ROLE_SYSTEM_PANEPanetabpanel
"textbox"ROLE_SYSTEM_TEXTDocumenttextbox
"timer"ROLE_SYSTEM_CLOCKPanetimer
"toolbar"ROLE_SYSTEM_TOOLBARToolbartoolbar
"tooltip"ROLE_SYSTEM_TOOLTIPTooltiptooltip
"tree"ROLE_SYSTEM_OUTLINETreetree
"treegrid"ROLE_SYSTEM_TABLEDataGridtreegrid
"treeitem"ROLE_SYSTEM_OUTLINEITEMTreeItemtreeitem

 

W3C ARIA States and Properties

W3C ARIA States and Properties are mapped to various properties and functions of Microsoft Active Accessibility and UI Automation. With few exceptions, most of the ARIA States and Properties are supported by the UI Automation AriaProperties property.

The exceptions are as follows:

  • ARIA properties that take object references, such as described by the ARIA property
  • ARIA properties that are supported by the accessibility object model

For example, the ARIA aria-activedescendant property is always expected to be represented as a focused element in the accessibility object model. The ARIA aria-owns property must also be 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 "=" (equals) and ";" (semicolon); for example, checked=true;disabled=false. The backslash character ("\") is used as an escape when these delimiter characters or "\" appear in the values. The UI Automation provider code can add verification to validate the original ARIA properties in the Document Object Model (DOM) , but it is not required.

W3C ARIA States and PropertiesMicrosoft Active Accessibility Properties UI Automation PropertiesUI Automation ARIA AriaProperties Property
aria-activedescendant STATE_SYSTEM_FOCUSED (IAccessible::get_accState) HasKeyboardFocus (a property of the child element that is designated to receive the focus)N/A
aria-atomic††N/AN/Aatomic
aria-busy STATE_SYSTEM_BUSY (get_accState) N/Abusy
aria-channel††N/AN/Achannel
aria-checked STATE_SYSTEM_CHECKED (get_accState) ToggleState (Toggle Pattern)checked
aria-controls N/AControllerForN/A
aria-describedby N/ADescribedByN/A
aria-disabled STATE_SYSTEM_UNAVAILABLE (get_accState) IsEnableddisabled
aria-dropeffect††N/AN/Adropeffect
aria-expanded STATE_SYSTEM_COLLAPSED or STATE_SYSTEM_EXPANDED (get_accState) ExpandCollapseState (ExpandCollapse Pattern)expanded
aria-flowto N/AFlowsToN/A
aria-grab††N/AN/Agrab
aria-haspopup STATE_HASPOPUPN/Ahaspopup
aria-hidden STATE_SYSTEM_INVISIBLEIsOffscreenhidden
aria-invalid N/AIsDataInvalidForForminvalid
aria-labelledby N/ALabeledByN/A
aria-level IAccessible::get_accValue N/A (represented by automation element tree structure)level
aria-live N/AN/Alive
aria-multiline††N/ADocument Control Typemultiline
aria-multiselect STATE_SYSTEM_EXTSELECTABLE (get_accState) CanSelectMultiple (Selection Pattern)multiselectable
aria-owns N/A (should be reflected in the accessible object tree)N/A (should be reflected in the automation element tree)N/A
aria-posinset N/A (represented in the accessible object tree structure or by childId)N/A (represented in automation element tree structure)posinset
aria-pressed STATE_SYSTEM_PRESSED (get_accState) ToggleState (Toggle Pattern)pressed
aria-readonly STATE_SYSTEM_READONLY (get_accState) IsReadOnlyreadonly
aria-relevant N/AN/Arelevant
aria-required N/AIsRequiredForFormrequired
aria-secret STATE_SYSTEM_PROTECTED (get_accState IsPasswordsecret
aria-selected STATE_SYSTEM_SELECTED (get_accState) IsSelected (SelectionItem Pattern)selected
aria-setsize N/AN/A (child count in automation element tree structure)setsize
aria-sort††N/AN/Asort
tabIndex STATE_SYSTEM_FOCUSABLE (get_accState) IsKeyboardFocusabletabindex
aria-valuemax N/AMaximumProperty (RangeValue Pattern)valuemax
aria-valuemin N/AMinimumProperty (RangeValue Pattern)valuemin
aria-valuenow get_accValue ValueProperty (RangeValue Pattern)valuenow
aria-valuetext†† get_accValue NOTE: when both aria-valuenow and aria-valuetext ARIA properties are set, get_accValue will hold the data from the aria-valuetext property. ValueProperty (Value Pattern) NOTE: RangeValue and Value Pattern can coexist with UI in case both aria-valuetext and aria-valuenow are specified.valuetext

 

† Not implemented in Internet Explorer 8.

Related topics

Microsoft Active Accessibility and UI Automation
Microsoft Active Accessibility SDK
Microsoft Active Accessibility Constants and Enumerated Types
UI Automation Specification and Community Promise
UI Automation for Win32 Applications
ARIA Specification Sources
Accessible Rich Internet Applications (WAI-ARIA) Version 1.0
ARIA User Agent Implementors Guide

 

 

Show:
© 2014 Microsoft