Share via

UI Automation Support for the Window Control Type

  • Article

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

The window control consists of the window frame, which contains child objects such as title bar, client, and other objects.

The following sections define the required UI Automation tree structure, properties, control patterns, and events for the Window control type. The UI Automation requirements apply to all window 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 window 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
  • Window
  • Window

Required UI Automation Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to window 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 window control must have a clickable point that causes the window to become selected or unselected.
UIA_ControlTypePropertyId Window This value is the same for all UI frameworks.
UIA_IsContentElementPropertyId TRUE The window control is always included in the content view of the UI Automation tree.
UIA_IsControlElementPropertyId TRUE The window 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 Window controls do not have a static window label.
UIA_LocalizedControlTypePropertyId See notes. Localized string corresponding to the Window control type. The default value is "window" for en-US or English (United States).
UIA_NamePropertyId See notes. The window control always contains a primary Window element that relates to what the user would associate as the most semantic identifier for the item.

Required UI Automation Control Patterns

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

Control Pattern/Pattern Property Support/Value Notes
IDockProvider Conditional Must be supported if the window can be docked.
ITransformProvider Required Enables the window to be moved, resized, or rotated on the screen.
IWindowProvider Required Enables specific operations for the window.

Required UI Automation Events

The following table lists the UI Automation events that window controls are required to support. For more information on events, see UI Automation Events Overview.

UI Automation Event Notes
UIA_AsyncContentLoadedEventId None
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_LayoutInvalidatedEventId None
UIA_NamePropertyId property-changed event. None
UIA_ScrollHorizontallyScrollablePropertyId property-changed event. If the control supports the Scroll control pattern, it must support this event.
UIA_ScrollHorizontalScrollPercentId property-changed event. If the control supports the Scroll control pattern, it must support this event.
UIA_ScrollHorizontalViewSizePropertyId property-changed event. If the control supports the Scroll control pattern, it must support this event.
UIA_ScrollVerticallyScrollablePropertyId property-changed event. If the control supports the Scroll control pattern, it must support this event.
UIA_ScrollVerticalScrollPercentId property-changed event. If the control supports the Scroll control pattern, it must support this event.
UIA_ScrollVerticalViewSizePropertyId property-changed event. If the control supports the Scroll control pattern, it must support this event.
UIA_StructureChangedEventId None
UIA_Window_WindowClosedEventId None
UIA_Window_WindowOpenedEventId None
UIA_WindowWindowVisualStatePropertyId property-changed event. If the control supports the WindowVisualState property of the Window control pattern, this event must be supported.