Edit

Slider Control Type

  • Article

This topic provides information about Microsoft UI Automation support for the Slider control type.

A slider control is a composite control with buttons that enable a user to set a numerical range or select from a set of items.

The following sections define the required UI Automation tree structure, properties, control patterns, and events for the Slider control type. The UI Automation requirements apply to all slider 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 slider 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
  • Slider
    • Button (2 or 4)
    • Thumb (1)
    • List Item (0 or more)
  • Slider
    • List Item (0 or more)

 

Relevant Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to slider controls. 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. The majority of slider controls must return the UIA_E_NOCLICKABLEPOINT error because the entire bounding rectangle of the slider control is occupied by child controls.
UIA_ControlTypePropertyId Slider This value is the same for all frameworks.
UIA_IsContentElementPropertyId TRUE The slider control is always included in the content view of the UI Automation tree.
UIA_IsControlElementPropertyId TRUE The slider 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. The children (buttons and thumb) of a slider control should never take the focus. The focus should always remain on the slider control itself.
UIA_LabeledByPropertyId See notes. If there is a static text label associated with the control, this property must expose a reference to that control. If the text control is a subcomponent of another control, it will not have a LabeledBy property set.
UIA_LocalizedControlTypePropertyId See notes. Localized string corresponding to the Slider control type. The default value is "slider" for en-US or English (United States).
UIA_NamePropertyId See notes. The name of the slider control is typically generated from a static text label. If there is not a static text label, a property value for Name must be assigned by the application developer.

 

Required Control Patterns

The following table lists the UI Automation control patterns required to be supported by all slider controls. For more information on control patterns, see UI Automation Control Patterns Overview.

Control Pattern/Pattern Property Support/Value Notes
IRangeValueProvider Depends A slider should support the RangeValue control pattern if the content can be set to a value within a numerical range.
ISelectionProvider Depends A slider should support the Selection control pattern if the content represents one value among a discrete set of options. When the Selection control pattern is supported, the corresponding selection must be exposed as one or more child list items of the slider.
IValueProvider Depends A slider should support the Value control pattern if the content represents one value among a discrete set of options.

 

Required Events

The following table lists the UI Automation events that slider controls 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_RangeValueValuePropertyId property-changed event. If the control supports the RangeValue control pattern, it must support this event.
UIA_Selection_InvalidatedEventId If the control supports the Selection control pattern, it must support this event.
UIA_StructureChangedEventId
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