UI Automation Support for the TitleBar 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 TitleBar 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.
Title bar controls represent titles or caption bars 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, 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 title 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 |
|---|---|
| TitleBar - Menu (0 or 1) - Button (0 or more) |
Not applicable. (the title bar control has no content.) |
Required UI Automation Properties
The following table lists the UI Automation properties whose value or definition is especially relevant to TitleBar controls. For more information about 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 bounding rectangle of a title bar must encompass all of the controls contained within it. |
| 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 | False | Title bars never have keyboard focus. |
| NameProperty | "" | The title bar is not content; its textual information is exposed on the parent window. |
| LabeledByProperty | See notes. | The title bar control usually does not have a label. |
| ControlTypeProperty | TitleBar | This value is the same for all UI frameworks. |
| LocalizedControlTypeProperty | "title bar" | Localized string corresponding to the TitleBar control type. |
| IsContentElementProperty | False | The title bar control is never content. |
| IsControlElementProperty | True | The title bar control must always be a control. |
| IsOffscreenProperty | Depends | This control will return a value depending on whether the title bar is visible on the screen. |
| HelpTextProperty | "" | It is not necessary to expose Help text. |
| AcceleratorKeyProperty | "" | Title bars never have accelerator keys. |
| AccessKeyProperty | "" | The title bar control does not have an access key. |
Required UI Automation 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.
Required UI Automation Events
The following table lists the UI Automation events required to be supported by all title bar controls. For more information about 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. | Never | None |
| AutomationFocusChangedEvent | Never | None |
| StructureChangedEvent | Required | None |