Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Header Control Type

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 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 controls and describes what can be contained in each view. For more information about the UI Automation tree, see UI Automation Tree Overview.

Control ViewContent View
  • Header
    • HeaderItem (1 or more)
(Not applicable)

 

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.

Relevant 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 Retrieving Properties from UI Automation Elements.

UI Automation PropertyValueNotes
UIA_AutomationIdPropertyIdSee notes.The value of this property must be unique across all controls in an application.
UIA_BoundingRectanglePropertyIdSee notes.The outermost rectangle that contains the whole control.
UIA_ClickablePointPropertyIdSee 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_ControlTypePropertyIdHeader
UIA_IsContentElementPropertyIdFALSEThe header control is not included in the content view of the UI Automation tree.
UIA_IsControlElementPropertyIdTRUEThe header control is always included in the control view of the UI Automation tree.
UIA_IsKeyboardFocusablePropertyIdSee notes.If the control can receive keyboard focus, it must support this property.
UIA_LabeledByPropertyIdNULLHeader controls do not have a static label.
UIA_LocalizedControlTypePropertyIdSee notes. The default value is "header" for en-US or English (United States).
UIA_NamePropertyIdSee 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_OrientationPropertyIdOrientationType_Horizontal or OrientationType_VerticalThe 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 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 PatternSupportNotes
ITransformProvider DependsImplement the Transform control pattern if the header control can be resized.

 

Required 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 EventNotes
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

Conceptual
UI Automation Control Types Overview
UI Automation Overview

 

 

Show:
© 2016 Microsoft