UI Automation Support for the Pane Control Type

 
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 provides information about UI Automation support for the Pane 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 and control patterns.

The Pane control type is used to represent an object within a frame or document window. Users can navigate between pane controls and within the contents of the current pane, but cannot navigate between items in different panes. Thus, pane controls represent a level of grouping lower than windows or documents, but above individual controls. The user navigates between panes by pressing TAB, F6, or CTRL+TAB, depending on the context. No specific keyboard navigation is required by the Pane control type.

The following sections define the required UI Automation tree structure, properties, control patterns, and events for the Pane control type. The UI Automation requirements apply to all list controls, whether Windows Presentation Foundation (WPF), Win32, or Windows Forms.

The following table depicts the control view and the content view of the UI Automation tree that pertains to pane controls and describes what can be contained in each view. For more information on the UI Automation tree, see UI Automation Tree Overview.

Control ViewContent View
PanePane

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

UI Automation PropertyValueNotes
AutomationIdPropertySee notes.The value of this property needs to be unique across all controls in an application.
BoundingRectanglePropertySee notes.The outermost rectangle that contains the whole control.
IsKeyboardFocusablePropertySee notes.If the control can receive keyboard focus, it must support this property.
NamePropertySee notes.The value for this property must always be a clear, concise and meaningful title.
ClickablePointPropertySee notes.This property exposes a clickable point of the pane control that causes the pane to become focused when it is clicked.
LabeledByPropertySee notes.Pane controls typically do not have a static label. If there is a static text label, it should be exposed through this property.
ControlTypePropertyPaneThis value is the same for all UI frameworks.
LocalizedControlTypeProperty"pane"Localized string corresponding to the Pane control type.
IsContentElementPropertyTruePane controls are always included in the content view of the UI Automation tree.
IsControlElementPropertyTruePane controls are always included in the control view of the UI Automation tree.
HelpTextProperty""The help text for pane controls should explain why the purpose of the frame and how it relates to other frames. A description is necessary if the purpose and relationship of frames is not clear from the value of the NameProperty. "
AccessKeyPropertySee notes.If a specific key combination gives focus to the pane then that information should be exposed through this property.

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

Control PatternSupportNotes
ITransformProviderDependsImplement this control pattern if the pane control can be moved, resized, or rotated on the screen.
IWindowProviderNeverIf you need to implement this control pattern, your control should be based on the Window control type.
IDockProviderDependsImplement this control pattern if the pane control can be docked.
IScrollProviderDependsImplement this control pattern if the pane control can be scrolled.

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

UI Automation EventSupport/ValueNotes
WindowClosedEventNeverNone
WindowOpenedEventNeverNone
AsyncContentLoadedEventRequiredNone
BoundingRectangleProperty property-changed event.RequiredNone
IsOffscreenProperty property-changed event.RequiredNone
IsEnabledProperty property-changed event.RequiredNone
HorizontallyScrollableProperty property-changed event.DependsNone
HorizontalScrollPercentProperty property-changed event.DependsNone
HorizontalViewSizeProperty property-changed event.DependsNone
VerticalScrollPercentProperty property-changed event.DependsNone
VerticallyScrollableProperty property-changed event.DependsNone
VerticalViewSizeProperty property-changed event.DependsNone
WindowVisualStateProperty property-changed event.NeverNone
AutomationFocusChangedEventRequiredNone
StructureChangedEventRequiredNone

The following image illustrates a control that implements the Pane control type.

Screenshot of applet window with two panes

UI Automation Tree - Control ViewUI Automation Tree - Content View
  • Pane
  • Tree (Scroll Pattern)

     
    • TreeItem
    • Pane
    • Edit (Scroll Pattern
- Pane
- Tree (Scroll Pattern)
- TreeItem
- …Pane
- Edit
- (Scroll Pattern)

Pane
UI Automation Control Types Overview
UI Automation Overview

Show: