Edit

HeaderItem Control Type

  • Article

This topic provides information about Microsoft UI Automation support for the HeaderItem control type.

The HeaderItem control type provides a visual label for a row or column of information.

The following sections define the required UI Automation tree structure, properties, control patterns, and events for the HeaderItem control type. The UI Automation requirements apply to all header item 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 header item 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
  • HeaderItem
 (Not applicable)

 

Relevant Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to the HeaderItem 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 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 the element performs specialized hit testing, override and provide a clickable point.
UIA_ControlTypePropertyId HeaderItem This value is the same for all UI frameworks.
UIA_IsContentElementPropertyId FALSE The header item control is not included in the content view of the UI Automation tree.
UIA_IsControlElementPropertyId TRUE The header item 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_ItemStatusPropertyId See notes This property provides information for sort orders by the header item.
UIA_LabeledByPropertyId NULL Header item controls do not have a static text label.
UIA_LocalizedControlTypePropertyId See notes. Localized string corresponding to the HeaderItem control type. The default value is "header item" for en-US or English (United States).
UIA_NamePropertyId See notes. The header item control is always self-labeling.

 

Required Control Patterns

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

Control Pattern Support Notes
IInvokeProvider Depends Implement the Invoke control pattern if the header item control can be clicked to sort the data.
ITransformProvider Depends Implement the Transform control pattern if the header item control can be resized.

 

Required Events

The following table lists the UI Automation events that header item 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_Invoke_InvokedEventId If the control supports the Invoke 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

 

Conceptual

UI Automation Control Types Overview

UI Automation Overview