TitleBar Control Type
This topic provides information about Microsoft UI Automation support for the TitleBar control type. A title bar control represents a title or caption bar in a window.
The following sections define the required UI Automation tree structure, properties, control patterns, and events for the TitleBar control type. The UI Automation requirements apply to all title bar 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 title bar 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 |
---|---|
|
(Not applicable; the title bar control has no content) |
Relevant Properties
The following table lists the UI Automation properties whose value or definition is especially relevant to the TitleBar control type. For more information about UI Automation properties, see Retrieving Properties from UI Automation Elements.
UI Automation Property | Value | Notes |
---|---|---|
UIA_AutomationIdPropertyId | See notes. | The value of this property must be unique among all peer elements in the raw view of the UI Automation tree. |
UIA_BoundingRectanglePropertyId | See notes. | The value exposed by this property must include all of the controls contained within it. |
UIA_ClickablePointPropertyId | See 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_ControlTypePropertyId | TitleBar | This value is the same for all UI frameworks. |
UIA_IsContentElementPropertyId | FALSE | The title bar control is never included in the content view of the UI Automation tree. |
UIA_IsControlElementPropertyId | TRUE | The title bar control is always included in the control view of the UI Automation tree. |
UIA_IsKeyboardFocusablePropertyId | FALSE | A title bar control never has keyboard focus. |
UIA_IsOffscreenPropertyId | Depends | A title bar control returns a value depending on whether it is visible on the screen. |
UIA_LabeledByPropertyId | See notes. | A title bar control typically does not have a label. |
UIA_LocalizedControlTypePropertyId | See notes. | Localized string corresponding to the TitleBar control type. The default value is "title bar" for en-US or English (United States). |
UIA_NamePropertyId | "" | A title bar is not content; its textual information is exposed by the name of the parent window. |
Required Control Patterns
The TitleBar control type is not required to support any control patterns. Its functionality is exposed through the Window control pattern on the Window control type.
Required Events
The following table lists the UI Automation events that title bar controls are required to support. For more information on events, see UI Automation Events Overview.
UI Automation Event | Notes |
---|---|
UIA_AutomationFocusChangedEventId | |
UIA_BoundingRectanglePropertyId property-changed 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