Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This topic provides information about Microsoft UI Automation support for the Header control type.
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 Microsoft Windows Presentation Foundation (WPF), Microsoft Win32, or Windows Forms.
This topic contains the following sections.
- Required UI Automation Tree Structure
- Required UI Automation Properties
- Required UI Automation Control Patterns
- Required UI Automation Events
- Related Topics
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 controls always have one 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 the header controls. For more information about UI Automation properties, see UI Automation Properties for Clients.
| UI Automation Property | Value | Notes |
|---|---|---|
| UIA_AutomationIdPropertyId | See notes. | The value of this property must be unique across all controls in an application. |
| UIA_BoundingRectanglePropertyId | See notes. | The outermost rectangle that contains the whole control. |
| UIA_ClickablePointPropertyId | 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, override and provide a clickable point. |
| UIA_ControlTypePropertyId | Header | This value is the same for all UI frameworks. |
| UIA_IsContentElementPropertyId | FALSE | The header control is not included in the content view of the UI Automation tree. |
| UIA_IsControlElementPropertyId | TRUE | The header control is always included in the control view of the UI Automation tree. |
| UIA_IsKeyboardFocusablePropertyId | See notes. | If the control can receive keyboard focus, it must support this property. |
| UIA_LabeledByPropertyId | NULL | Header controls do not have a static label. |
| UIA_LocalizedControlTypePropertyId | See notes. | This value is the same for all UI frameworks. The default value is "header" for en-US or English (United States). |
| UIA_NamePropertyId | 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. |
| UIA_OrientationPropertyId | OrientationType_Horizontal or OrientationType_Vertical | The value of this property exposes the position of the header control—whether it is a row header (OrientationType_Horizontal) or column header (OrientationType_Vertical). |
Required UI Automation Control Patterns
The following table lists the UI Automation control patterns required to be supported for header controls. For more information on control patterns, see UI Automation Control Patterns Overview.
| Control Pattern/Pattern Property | Support/Value | 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 that header controls are required to support. For more information on events, see UI Automation Events Overview.
| UI Automation Event | Notes |
|---|---|
| UIA_AutomationFocusChangedEventId | None |
| UIA_BoundingRectanglePropertyId property-changed event. | None |
| 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 | None |