UI Automation Support for the 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, 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 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 View | Content View |
|---|---|
|
|
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.
Required UI Automation 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 UI Automation Properties for Clients.
| UI Automation Property | Value | Notes |
|---|---|---|
| UIA_AutomationIdPropertyId | See notes. | The value of this property needs to 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 | Table | This value is the same for all UI frameworks. |
| UIA_DescribedBy | See 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_HelpTextPropertyId | See 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_IsContentElementPropertyId | TRUE | The table control must always appear in the content view of the UI Automation tree. |
| UIA_IsControlElementPropertyId | TRUE | The table control must always appear 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 | See notes. | If there is a static text label, this property should expose a reference to the automation element of the control. |
| UIA_LocalizedControlTypePropertyId | See notes. | Localized string corresponding to the Table control type. The default value is "table" for en-US or English (United States). |
| UIA_NamePropertyId | See notes. | The table control typically gets the value for its mame from a static text label. If there is not a static text label, you must assign a Name property that must always be available to explain the purpose of the table. |
Required UI Automation 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 Pattern/Pattern Property | Support/Value | Notes |
|---|---|---|
| IGridProvider | Yes | Because the table control contains items presented in a grid, it always supports the Grid control pattern. |
| IGridItemProvider | Yes (required with child objects) | The 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. |
| ITableProvider | Yes | The table control can always have headers associated with the content. |
| ITableItemProvider | Yes (required with child objects) | The 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 UI Automation 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 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 |