UI Automation Support for the Header 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 Header 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 header control provides a visual container for the labels for rows or columns of information.
The following sections define the required UI Automation tree structure, properties, control patterns, and events for the Header control type. The UI Automation requirements apply to all header 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 header 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 |
|---|---|
| Header - HeaderItem (1 or more) |
None |
Header controls always have 1 or more children in the control view of the UI Automation tree.
Header controls have zero children in the content view of the UI Automation tree.
Required UI Automation Properties
The following table lists the UI Automation properties whose value or definition is especially relevant to header 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 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 | See notes. | The header control needs a name if there is more than one row header or more than one column header. This identifies the information within the header. |
| LabeledByProperty | Null. |
Header controls do not have a static label. |
| ControlTypeProperty | Header | This value is the same for all UI frameworks. |
| LocalizedControlTypeProperty | "header" | This value is the same for all UI frameworks. |
| OrientationProperty | Horizontal | The value of this property exposes the position of the header control - whether it is a row header or column header. |
| IsContentElementProperty | False | The header control is not included in the content view of the UI Automation tree. |
| IsControlElementProperty | True | The header control is always included in the control view of the UI Automation tree. |
Required UI Automation Control Patterns
The following table lists the UI Automation control patterns required to be supported by all header controls. For more information on control patterns, see UI Automation Control Patterns Overview.
| Control Pattern | Support | Notes |
|---|---|---|
| ITransformProvider | Depends | Implement this control pattern if the header control can be resized. |
Required UI Automation Events
The following table lists the UI Automation events required to be supported by all header 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 |
| AutomationFocusChangedEvent | Required | None |
| StructureChangedEvent | Required | None |