UI Automation Support for the RadioButton Control Type
This topic provides information about Microsoft UI Automation support for the RadioButton control type.
A radio button consists of a round button and application-defined text (a label), an icon, or a bitmap that indicates a choice the user can make by selecting the button. An application typically uses radio buttons in a group box to permit the user to choose from a set of related, but mutually exclusive options. For example, the application might present a group of radio buttons from which the user can select a format preference for text selected in the client area. The user could select a left-aligned, right-aligned, or centered format by selecting the corresponding radio button. Typically, the user can select only one option at a time from a set of radio buttons.
The following sections define the required UI Automation tree structure, properties, control patterns, and events for the RadioButton control type. The UI Automation requirements apply to all button controls, whether Microsoft Windows Presentation Foundation (WPF), Microsoft Win32, or Windows Forms.
This topic contains the following sections.
- Required UI Automation Tree Structure
- Required UI Automation Properties
- Required UI Automation Control Patterns
- Required UI Automation Events
- Remarks
- Related Topics
Required UI Automation Tree Structure
The following table depicts the control view and the content view of the UI Automation tree that pertains to radio button controls and describes what can be contained in each view. For more information about the UI Automation tree, see UI Automation Tree Overview.
| Control View | Content View |
|---|---|
|
|
There are no children in the control view or the content view.
Required UI Automation Properties
The following table lists the UI Automation properties whose value or definition is especially relevant to the controls that implement the RadioButton control type (such as button controls). For more information about UI Automation properties, see UI Automation Properties for Clients.
| UI Automation Property | Value | Notes |
|---|---|---|
| UIA_AutomationIdPropertyId | See notes. | The value of this property needs to be unique across all controls in an application. |
| UIA_BoundingRectanglePropertyId | See notes. | The outermost rectangle that contains the whole control. |
| UIA_ClickablePointPropertyId | See notes. | The clickable point must be a point that, when clicked, selects the radio button. |
| UIA_ControlTypePropertyId | RadioButton | This value is the same for all UI frameworks. |
| UIA_IsContentElementPropertyId | TRUE | The radio button control is always included in the content view of the UI Automation tree. |
| UIA_IsControlElementPropertyId | TRUE | The radio button control is always included in the control view of the UI Automation tree. |
| UIA_IsKeyboardFocusablePropertyId | See notes. | If the control can receive keyboard focus, it must support this property. |
| UIA_LabeledByPropertyId | NULL | Radio button controls are self-labeled by their contents. |
| UIA_LocalizedControlTypePropertyId | See notes. | Localized string corresponding to the RadioButton control type. The default value is "radio button" for en-US or English (United States). |
| UIA_NamePropertyId | See notes. | The name of the radio button control is the text that is displayed beside the button that maintains the selection state. |
Required UI Automation Control Patterns
The following table lists the UI Automation control patterns required to be supported by all radio button controls. For more information on control patterns, see UI Automation Control Patterns Overview.
| Control Pattern/Pattern Property | Support/Value | Notes |
|---|---|---|
| ISelectionItemProvider | Yes | All radio button controls must support the SelectionItem control pattern to enable themselves to be selected. |
| ISelectionItemProvider::SelectionContainer | See notes. | The ISelectionItemProvider::SelectionContainer property must always be completed so that a UI Automation client can determine what other radio buttons within a specific context relate to one another. For the Win32 version of the radio button, this property is not supported because it is not possible to obtain this information from that legacy framework. |
| IToggleProvider | Never | The radio button cannot cycle through its state once it has been set. This pattern must never be supported on a radio button. |
Required UI Automation Events
The following table lists the UI Automation events that button controls are required to support. For more information on events, see UI Automation Events Overview.
| UI Automation Event | Notes |
|---|---|
| UIA_AutomationFocusChangedEventId | None |
| UIA_BoundingRectanglePropertyId property-changed event. | None |
| UIA_IsEnabledPropertyId property-changed event. | If the control supports the IsEnabled property, it must support this event. |
| UIA_IsOffscreenPropertyId property-changed event. | If the control supports the IsOffscreen property, it must support this event. |
| UIA_SelectionItem_ElementRemovedFromSelectionEventId | If the control supports the SelectionItem control pattern, it must support this event. |
| UIA_SelectionItem_ElementSelectedEventId | If the control supports the SelectionItem control pattern, it must support this event. |
| UIA_StructureChangedEventId | None |
Remarks
A radio button represents a single selectable option among a group of peer radio buttons. Ideally, radio buttons should have a grouping element that clarifies the boundaries of the peer radio buttons. Often, however, the boundary is implied by the user interface (UI) element structure. For example, a menu might contain a set of consecutive radio buttons instead of menu items, or a set of radio buttons that occur after a group label, but before an actionable element such as button.