UI Automation Support for the ToolTip Control Type
This topic provides information about UI Automation support for the ToolTip 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.
Tooltip controls are pop-up windows that contain text.
The following sections define the required UI Automation tree structure, properties, control patterns, and events for the ToolTip control type. The UI Automation requirements apply to all tooltip controls, whether Windows Presentation Foundation (WPF), Win32, or
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 tooltip 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 |
|---|---|
|
|
Tooltip controls appear only in the Content View of the UI Automation tree if they can receive keyboard focus. Otherwise, all of the tooltip's information is available from the HelpTextProperty on the UI Automation element that the tooltip is referring to.
Tooltips should appear beneath the control that their information is referring to. Clients must listen for the ToolTipOpenedEvent to ensure that they consistently obtain information contained in tooltips.
Required UI Automation Properties
The following table lists the UI Automation properties whose value or definition is especially relevant to Tooltip controls. For more information about UI Automation properties, see UI Automation Properties for Clients.
| UI Automation Property | Value | Notes |
|---|---|---|
See notes. |
The value of this property needs to be unique across all controls in an application. |
|
See notes. |
The outermost rectangle that contains the whole control. |
|
See notes. |
The clickable point should be the part of the tooltip that will dismiss the control. Some tooltips do not have this ability and will not have a clickable point. |
|
See notes. |
If the control can receive keyboard focus, it must support this property. |
|
See notes. |
The name of the Tooltip control is the text that is displayed within the tooltip. |
|
Null |
Tooltip controls are always self-labeled by their contents. |
|
ToolTip |
This value is the same for all UI frameworks. |
|
"ToolTip" |
Localized string corresponding to the ToolTip control type. |
|
Depends |
If the Tooltip control can receive keyboard focus, it must be in the Content View of the tree. If it is text only, then it is available as the HelpTextProperty from the control that raised it. |
|
True |
The tooltip control must always be a control. |
|
Null |
The HelpText property will always be null for a tooltip control. |
Required UI Automation Control Patterns
The following table lists the UI Automation control patterns required to be supported by tooltip controls. For more information on control patterns, see UI Automation Control Patterns Overview.
| Control Pattern/Pattern Property | Support/Value | Notes |
|---|---|---|
Depends |
Tooltips that can be closed by clicking a UI item must support WindowPattern so that they can closed automatically. |
|
Depends |
Not all UI Automation providers will be able to expose TextPattern for tooltip controls. |
Required UI Automation Events
Tooltip controls must raise the ToolTipOpenedEvent when they appear on the screen. The event will include a reference to the UI Automation element of the tooltip itself.
The following table lists the UI Automation events required to be supported by all tooltip controls. For more information about events, see UI Automation Events Overview.
| UI Automation Event | Support | Notes |
|---|---|---|
Depends |
None |
|
Depends |
None |
|
Depends |
None |
|
Depends |
None |
|
Required |
None |
|
Required |
None |
|
BoundingRectangleProperty property-changed event. |
Required |
None |
IsOffscreenProperty property-changed event. |
Required |
None |
IsEnabledProperty property-changed event. |
Required |
None |
NameProperty property-changed event. |
Required |
None |
WindowVisualStateProperty property-changed event. |
Depends |
None |
Required |
None |
|
Required |
None |