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.

Table Control Type

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

Table controls contain rows and columns of text and, optionally, row headers and column headers.

The following sections define the required UI Automation tree structure, properties, control patterns, and events for the Table control type. The UI Automation requirements apply to all table 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 table 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
  • Table
    • Text (0 or 1)
    • Header (0 or more)
    • Various controls (0 or more)
  • Table
    • Text (1 or more)
    • Various controls (0 or more)

 

If a table control has row or column headers, they must be exposed in the control view of the UI Automation tree. The content view does not need to expose this information because it can be accessed using IUIAutomationTablePattern.

Relevant Properties

The following table lists the UI Automation properties whose value or definition is especially relevant to table 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 among all peer elements in the raw view of the UI Automation tree.
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_ControlTypePropertyIdTable
UIA_DescribedByPropertyIdSee notes.If the table is annotated by other UI element (for example, a text element that holds the description for the table), the DescribedBy property should expose a reference to the automation element of the text control.
UIA_HelpTextPropertyIdSee notes.More details about the purpose of the table should be exposed through this property if it is not sufficiently explained by the UIA_NamePropertyId property.
UIA_IsContentElementPropertyIdTRUEThe table control must always appear in the content view of the UI Automation tree.
UIA_IsControlElementPropertyIdTRUEThe table control must always appear 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_LabeledByPropertyIdSee notes.If there is a static text label, this property should expose a reference to the automation element of the control.
UIA_LocalizedControlTypePropertyIdSee notes.Localized string corresponding to the Table control type. The default value is "table" for en-US or English (United States).
UIA_NamePropertyIdSee notes.The table control typically gets the value for its name from a static text label. If there is not a static text label, the element must assign a Name property that must always be available to explain the purpose of the table.

 

Required Control Patterns

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

Control PatternSupportNotes
IGridProvider RequiredBecause the table control contains items presented in a grid, it always supports the Grid control pattern.
IGridItemProvider Required with child objectsThe inner objects of a table should support both the GridItem and TableItem control patterns. The table itself need not support the GridItem or TableItem control pattern unless the table is part of another table.
ITableProvider RequiredThe table control can always have headers associated with the content.
ITableItemProvider Required with child objectsThe inner objects of a table should support both the GridItem and TableItem control patterns. The table itself need not support the GridItem or TableItem control patterns unless the table is part of another table.

 

Required Events

The following table lists the UI Automation events that table 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

 

 

Community Additions

Show:
© 2014 Microsoft