Share via


UI Automation Support for the HeaderItem 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 HeaderItem 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 HeaderItem control type provides a visual label for a row or column of information.

Header item controls are examples of controls that implement the HeaderItem control type. The UI Automation requirements in the following sections apply to all header controls, whether Windows Presentation Foundation (WPF), 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 item 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

HeaderItem

None

Required UI Automation Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to header item 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 item control is always self-labeling.

LabeledByProperty

Null.

Header item controls do not have a static label.

ControlTypeProperty

HeaderItem

This value is the same for all UI frameworks.

LocalizedControlTypeProperty

"header item"

Localized string for the HeaderItem control type.

IsContentElementProperty

False

The header item control is not included in the content view of the UI Automation tree.

IsControlElementProperty

True

The header item control is always included in the control view of the UI Automation tree.

ItemStatusProperty

See notes.

This property provides information for sort orders by the header item.

Required UI Automation 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

ITransformProvider

Depends

Implement this control pattern if the header item control can be resized.

IInvokeProvider

Depends

Implement this control pattern if the header item control can be clicked to sort the data.

Required UI Automation Events

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

UI Automation Event

Support

Notes

InvokedEvent

Depends

None

BoundingRectangleProperty property-changed event.

Required

None

IsOffscreenProperty property-changed event.

Required

None

IsEnabledProperty property-changed event.

Required

None

AutomationFocusChangedEvent

Required

None

StructureChangedEvent

Required

None

See Also

Reference

HeaderItem

Concepts

UI Automation Control Types Overview

UI Automation Overview