UI Automation Support for the ProgressBar Control Type
This topic provides information about Microsoft UI Automation support for the ProgressBar control type.
Progress bar controls indicate the progress of a lengthy operation. The control consists of a rectangle that is gradually filled with the system highlight color as an operation progresses.
The following sections define the required UI Automation tree structure, properties, control patterns, and events for the ProgressBar control type. The UI Automation requirements apply to all progress bar 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
- 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 progress bar 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 |
|---|---|
|
|
The progress bar controls do not have any children in the control or content view of the UI Automation tree.
Required UI Automation Properties
The following table lists the UI Automation properties whose value or definition is especially relevant to the progress bars. 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. | Supported if there is a bounding rectangle. If not every point within the bounding rectangle is clickable, and you perform specialized hit testing, override and provide a clickable point. |
| UIA_ControlTypePropertyId | ProgressBar | This value is the same for all UI frameworks. |
| UIA_IsContentElementPropertyId | True | The progress bar control is always included in the content view of the UI Automation tree. |
| UIA_IsControlElementPropertyId | True | The progress bar 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 | See notes. | If there is a static text label, this property must expose a reference to that control. |
| UIA_LocalizedControlTypePropertyId | See notes. | Localized string corresponding to the ProgressBar control type. The default value is "progress bar" for en-US or English (United States). |
| UIA_NamePropertyId | See notes. | The progress bar control typically gets its name from a static text label. If there is not a static text label the application developer must expose a value for the Name property. |
Required UI Automation Control Patterns
The following table lists the UI Automation control patterns required to be supported by progress bar controls. For more information on control patterns, see UI Automation Control Patterns Overview.
| Control Pattern/Pattern Property | Support/Value | Notes |
|---|---|---|
| IRangeValueProvider | Depends | Progress bar controls that take a numeric range must implement IRangeValueProvider. |
| IRangeValueProvider::Minimum | 0.0 | The value of this property must be the smallest value that the control can be set to. |
| IRangeValueProvider::Maximum | 100.0 | The value of this property must be the largest value that the control can be set to. |
| IRangeValueProvider::SmallChange | NaN | This property is not required because progress bar controls are read-only. |
| IRangeValueProvider::LargeChange | NaN | This property is not required because progress bar controls are read-only. |
| IValueProvider | Depends | Progress bar controls that give a textual indication of progress must implement IValueProvider. |
| IValueProvider::IsReadOnly | TRUE | The value for this property is always TRUE. |
| IValueProvider::Value | See notes. | This property exposes textual progress of a progress bar control. |
Required UI Automation Events
The following table lists the UI Automation events that progress bars 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_NamePropertyId property-changed event. | None |
| UIA_StructureChangedEventId | None |
| UIA_ValueValuePropertyId property-changed event. | If the control supports the Value control pattern, it must support this event. |