Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ToolBar Control Type

This topic provides information about Microsoft UI Automation support for the ToolBar control type. Toolbar 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 toolbar 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 toolbar controls and describes what can be contained in each view. For more information about the UI Automation tree, see UI Automation Tree Overview.

Control ViewContent View
  • ToolBar
    • Various controls (0 or more)
  • ToolBar
    • Various controls (0 or more)

 

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

Relevant Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to the ToolBar control type. For more information about UI Automation properties, see Retrieving Properties from UI Automation Elements.

UI Automation PropertyValueNotes
UIA_AutomationIdPropertyIdSee notes.The value of this property must be unique among all peer elements in the raw view of the UI Automation tree.
UIA_BoundingRectanglePropertyIdSee notes.The outermost rectangle that contains the whole control.
UIA_ClickablePointPropertyIdSee notes.Supported if there is a bounding rectangle. If not every point within the bounding rectangle is clickable, and the element performs specialized hit testing, override and provide a clickable point.
UIA_ControlTypePropertyIdToolBarThis value is the same for all UI frameworks.
UIA_IsContentElementPropertyIdTRUEThe toolbar control is always included in the content view of the UI Automation tree.
UIA_IsControlElementPropertyIdTRUEThe toolbar control is always included in the control view of the UI Automation tree.
UIA_IsKeyboardFocusablePropertyIdSee notes.If the control can receive keyboard focus, it must support this property.
UIA_LabeledByPropertyIdNULLA toolbar control never has a label.
UIA_LocalizedControlTypePropertyIdSee notes.Localized string corresponding to the ToolBar control type. The default value is "tool bar" for en-US or English (United States).
UIA_NamePropertyIdDependsThe toolbar 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").

 

Required Control Patterns

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

Control PatternSupportNotes
IDockProvider DependsIf the toolbar can be docked to different parts of the screen, it must support the Dock control pattern.
IExpandCollapseProvider DependsIf the toolbar can be expanded and collapsed to show more items, it must support the ExpandCollapse control pattern.
ITransformProvider DependsIf the toolbar can be resized, rotated, or moved, it must support the Transform control pattern.

 

Required Events

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

UI Automation EventNotes
UIA_AutomationFocusChangedEventId
UIA_BoundingRectanglePropertyId property-changed event.
UIA_ExpandCollapseExpandCollapseStatePropertyId property-changed event.If the control supports the ExpandCollapse control pattern, it must support this 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_StructureChangedEventId

 

Related topics

Conceptual
UI Automation Control Types Overview
UI Automation Overview

 

 

Community Additions

Show:
© 2014 Microsoft