UI Automation Support for the ProgressBar Control Type

Note

This documentation is intended for .NET Framework developers who want to use the managed UI Automation classes defined in the System.Windows.Automation namespace. For the latest information about UI Automation, see Windows Automation API: UI Automation.

This topic provides information about UI Automation support for the ProgressBar control type. In UI Automation, a control type is a set of conditions that a control must meet in order to use the ControlTypeProperty property. The conditions include specific guidelines for UI Automation tree structure, UI Automation property values, control patterns, and UI Automation events.

Progress bar controls are an example of controls that implement the ProgressBar control type. Progress bar controls are used to 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 list controls, whether Windows Presentation Foundation (WPF), Win32, or Windows Forms.

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 on 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.

Required UI Automation Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to progress bar controls. For more information on UI Automation properties, see UI Automation Properties for Clients.

UI Automation Property Value Notes
AutomationIdProperty See notes. The value of this property needs to be unique across all controls in an application.
BoundingRectangleProperty See notes. The outermost rectangle that contains the whole control.
ClickablePointProperty 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, then override and provide a clickable point.
IsKeyboardFocusableProperty See notes. If the control can receive keyboard focus, it must support this property.
NameProperty 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.
LabeledByProperty See notes. If there is a static text label then this property must expose a reference to that control.
ControlTypeProperty ProgressBar This value is the same for all UI frameworks.
LocalizedControlTypeProperty "progress bar" Localized string corresponding to the ProgressBar control type.
IsContentElementProperty True The progress bar control is always included in the content view of the UI Automation tree.
IsControlElementProperty True The progress bar control is always included in the control view of the UI Automation tree.

Required UI Automation Control Patterns and Properties

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
IValueProvider Depends Progress bar controls that give a textual indication of progress must implement IValueProvider.
IsReadOnly True The value for this property is always True.
Value See notes. This property exposes textual progress of a progress bar control.
IRangeValueProvider Depends Progress bar controls that take a numeric range must implement IRangeValueProvider
Minimum 0.0 The value of this property is the smallest value that the control can be set to.
Maximum 100.0 The value of this property is the largest value that the control can be set to.
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.

Required UI Automation Events

The following table lists the UI Automation events required to be supported by all progress bar controls. For more information on events, see UI Automation Events Overview.

UI Automation Event Support Notes
BoundingRectangleProperty property-changed event. Required None
IsOffscreenProperty property-changed event. Required None
IsEnabledProperty property-changed event. Required None
NameProperty property-changed event. Required None
ValueProperty property-changed event. Depends None
AutomationFocusChangedEvent Required None
StructureChangedEvent Required None

See Also

ProgressBar
UI Automation Control Types Overview
UI Automation Overview