Implementing the UI Automation Window Control Pattern

 
System_CAPS_ICON_note.jpg 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 introduces guidelines and conventions for implementing IWindowProvider, including information about WindowPattern properties, methods, and events. Links to additional references are listed at the end of the topic.

The WindowPattern control pattern is used to support controls that provide fundamental window-based functionality within a traditional graphical user interface (GUI). Examples of controls that must implement this control pattern include top-level application windows, multiple-document interface (MDI) child windows, resizable split pane controls, modal dialogs and balloon help windows.

When implementing the Window control pattern, note the following guidelines and conventions:

  • To support the ability to modify both window size and screen position using UI Automation, a control must implement ITransformProvider in addition to IWindowProvider.

  • Controls that contain title bars and title bar elements that enable the control to be moved, resized, maximized, minimized, or closed are typically required to implement IWindowProvider.

  • Controls such as tooltip pop-ups and combo box or menu drop-downs do not typically implement IWindowProvider.

  • Balloon help windows are differentiated from basic tooltip pop-ups by the provision of a window-like Close button.

  • Full-screen mode is not supported by IWindowProvider as it is feature-specific to an application and is not typical window behavior.

The following properties, methods, and events are required for the IWindowProvider interface.

Required memberMember typeNotes
InteractionStatePropertyNone
IsModalPropertyNone
IsTopmostPropertyNone
MaximizablePropertyNone
MinimizablePropertyNone
VisualStatePropertyNone
CloseMethodNone
SetVisualStateMethodNone
WaitForInputIdleMethodNone
WindowClosedEventEventNone
WindowOpenedEventEventNone
WindowInteractionStateEventIs not guaranteed to be ReadyForUserInteraction

Providers must throw the following exceptions.

Exception typeCondition
InvalidOperationExceptionSetVisualState

- When a control does not support a requested behavior.
ArgumentOutOfRangeExceptionWaitForInputIdle

- When the parameter is not a valid number.

UI Automation Control Patterns Overview
Support Control Patterns in a UI Automation Provider
UI Automation Control Patterns for Clients
UI Automation Tree Overview
Use Caching in UI Automation

Show: