Edit

ProgressBar Control Type

  • Article

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 where the UI framework/platform integrates UI Automation support for control types and control patterns.

This topic contains the following sections.

Typical Tree Structure

The following table depicts a typical control and 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
  • ProgressBar
  • ProgressBar

The progress bar controls do not have any children in the control or content view of the UI Automation tree.

Relevant Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to progress bars. For more information about UI Automation properties, see Retrieving Properties from UI Automation Elements.

UI Automation Property Value Notes
UIA_AutomationIdPropertyId See notes. The value of this property must be unique among all peer elements in the raw view of the UI Automation tree.
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 the element performs specialized hit testing, override and provide a clickable point.
UIA_ControlTypePropertyId ProgressBar
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 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 the RangeValue control pattern.
Minimum Depends The value of this property is the minimum value that the control can be set to. This value should be less than Maximum.
Maximum Depends The value of this property is the maximum value that the control can be set to. This value should be greater than Minimum.
SmallChange NaN This property is not required because progress bar controls are read-only.
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 the Value control pattern.
IsReadOnly TRUE The value for this property is always TRUE.
Value See notes. This property exposes textual progress of a progress bar control.

 

Required 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
UIA_BoundingRectanglePropertyId property-changed event.
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.
UIA_StructureChangedEventId
UIA_RangeValueValuePropertyId property-changed event. If the control supports the RangeValue control pattern, it must support this event.
UIA_ValueValuePropertyId property-changed event. If the control supports the Value control pattern, it must support this event.

 

Conceptual

UI Automation Control Types Overview

UI Automation Overview