UI Automation Support for the ToolBar 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 ToolBar 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. Tool bar controls enable end users to activate commands and tools contained within a application.

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

- Various controls (0 or more)
ToolBar

- Various controls (0 or more)

A tool bar control can contain any type of control within its subtree. They most often contain buttons, combo boxes, and split buttons.

Required UI Automation Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to tool 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 Depends The tool bar control does not need a name unless more than one is used within an application. If more than one is present, each must have a distinguishing name (for example, Formatting or Outlining).
LabeledByProperty Null Tool bar controls never have a label.
ControlTypeProperty ToolBar This value is the same for all UI frameworks.
LocalizedControlTypeProperty "tool bar" Localized string corresponding to the ToolBar control type.
IsContentElementProperty True The tool bar control is always content.
IsControlElementProperty True The tool bar control must always be a control.

Required UI Automation Control Patterns

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

Control Pattern Support Notes
ExpandCollapsePattern Depends If the tool bar can be expanded and collapsed to show more items, then it must support this pattern.
DockPattern Depends If the tool bar can be docked to different parts of the screen, then it must support this pattern.
TransformPattern Depends If the tool bar can be resized, rotated, or moved, it must support this pattern.

Required UI Automation Events

The following table lists the UI Automation events required to be supported by all tool 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
ExpandCollapseStateProperty property-changed event. Depends None
AutomationFocusChangedEvent Required None
StructureChangedEvent Required None

See Also

ToolBar
UI Automation Control Types Overview
UI Automation Overview