IUIAutomationElement interface
Exposes methods and properties for a UI Automation element, which represents a UI item.
When to implement
UI Automation client applications do not implement IUIAutomationElement.
Members
The IUIAutomationElement interface inherits from the IUnknown interface. IUIAutomationElement also has these types of members:
Methods
The IUIAutomationElement interface has these methods.
| Method | Description |
|---|---|
| BuildUpdatedCache |
Retrieves a new UI Automation element with an updated cache. |
| FindAll |
Returns all UI Automation elements that satisfy the specified condition. |
| FindAllBuildCache |
Returns all UI Automation elements that satisfy the specified condition, prefetches the requested properties and control patterns, and stores the prefetched items in the cache. |
| FindFirst |
Retrieves the first child or descendant element that matches the specified condition. |
| FindFirstBuildCache |
Retrieves the first child or descendant element that matches the specified condition, prefetches the requested properties and control patterns, and stores the prefetched items in the cache. |
| GetCachedChildren |
Retrieves the cached child elements of this UI Automation element. |
| GetCachedParent |
Retrieves from the cache the parent of this UI Automation element. |
| GetCachedPattern |
Retrieves from the cache the IUnknown interface of the specified control pattern of this UI Automation element. |
| GetCachedPatternAs |
Retrieves the control pattern interface of the specified pattern from the cache of this UI Automation element. |
| GetCachedPropertyValue |
Retrieves a property value from the cache for this UI Automation element. |
| GetCachedPropertyValueEx |
Retrieves a property value from the cache for this UI Automation element, optionally ignoring any default value. |
| GetClickablePoint |
Retrieves a point on the element that can be clicked. |
| GetCurrentPattern |
Retrieves the IUnknown interface of the specified control pattern on this UI Automation element. |
| GetCurrentPatternAs |
Retrieves the control pattern interface of the specified pattern on this UI Automation element. |
| GetCurrentPropertyValue |
Retrieves the current value of a property for this UI Automation element. |
| GetCurrentPropertyValueEx |
Retrieves a property value for this UI Automation element, optionally ignoring any default value. |
| GetRuntimeId |
Retrieves the unique identifier assigned to the UI element. |
| SetFocus |
Sets the keyboard focus to this UI Automation element. |
Properties
The IUIAutomationElement interface has these properties.
| Property | Access type | Description |
|---|---|---|
|
Read-only |
Retrieves the cached accelerator key for the element. | |
|
Read-only |
Retrieves the cached access key character for the element. | |
|
Read-only |
Retrieves the cached ARIA properties of the element. | |
|
Read-only |
Retrieves the cached ARIA role of the element. | |
|
Read-only |
Retrieves the cached UI Automation identifier of the element. | |
|
Read-only |
Retrieves the cached coordinates of the rectangle that completely encloses the element. | |
|
Read-only |
Retrieves the cached class name of the element. | |
|
Read-only |
Retrieves a cached array of UI Automation elements for which this element serves as the controller. | |
|
Read-only |
Retrieves a cached value that indicates the control type of the element. | |
|
Read-only |
Retrieves a cached value that indicates the culture associated with the element. | |
|
Read-only |
Retrieves a cached array of elements that describe this element. | |
|
Read-only |
Retrieves a cached array of elements that indicate the reading order after the current element. | |
|
Read-only |
Retrieves the cached name of the underlying UI framework associated with the element. | |
|
Read-only |
A cached value that indicates whether the element has keyboard focus. | |
|
Read-only |
Retrieves the cached help text for the element. | |
|
Read-only |
A cached value that indicates whether the element is a content element. | |
|
Read-only |
Retrieves a cached value that indicates whether the element is a control element. | |
|
Read-only |
Retrieves a cached value that indicates whether the element contains valid data for the form. | |
|
Read-only |
Retrieves a cached value that indicates whether the element is enabled. | |
|
Read-only |
Retrieves a cached value that indicates whether the element can accept keyboard focus. | |
|
Read-only |
Retrieves a cached value that indicates whether the element is off-screen. | |
|
Read-only |
Retrieves a cached value that indicates whether the element contains a disguised password. | |
|
Read-only |
Retrieves a cached value that indicates whether the element is required to be filled out on a form. | |
|
Read-only |
Retrieves a cached description of the status of an item within an element. | |
|
Read-only |
Retrieves a cached string that describes the type of item represented by the element. | |
|
Read-only |
Retrieves the cached element that contains the text label for this element. | |
|
Read-only |
Retrieves the cached localized description of the control type of the element. | |
|
Read-only |
Retrieves the cached name of the element. | |
|
Read-only |
Retrieves the cached window handle of the element. | |
|
Read-only |
Retrieves a cached value that indicates the orientation of the element. | |
|
Read-only |
Retrieves the cached ID of the process that hosts the element. | |
|
Read-only |
Retrieves a cached description of the provider for this element. | |
|
Read-only |
Retrieves the accelerator key for the element. | |
|
Read-only |
Retrieves the access key character for the element. | |
|
Read-only |
Retrieves the ARIA properties of the element. | |
|
Read-only |
Retrieves the ARIA role of the element. | |
|
Read-only |
Retrieves the UI Automation identifier of the element. | |
|
Read-only |
Retrieves the coordinates of the rectangle that completely encloses the element. | |
|
Read-only |
Retrieves the class name of the element. | |
|
Read-only |
Retrieves an array of elements for which this element serves as the controller. | |
|
Read-only |
Retrieves the control type of the element. | |
|
Read-only |
Retrieves the culture identifier for the element. | |
|
Read-only |
Retrieves an array of elements that describe this element. | |
|
Read-only |
Retrieves an array of elements that indicates the reading order after the current element. | |
|
Read-only |
Retrieves the name of the underlying UI framework. | |
|
Read-only |
Indicates whether the element has keyboard focus. | |
|
Read-only |
Retrieves the help text for the element. | |
|
Read-only |
Indicates whether the element is a content element. | |
|
Read-only |
Indicates whether the element is a control element. | |
|
Read-only |
Indicates whether the element contains valid data for a form. | |
|
Read-only |
Indicates whether the element is enabled. | |
|
Read-only |
Indicates whether the element can accept keyboard focus. | |
|
Read-only |
Indicates whether the element is off-screen. | |
|
Read-only |
Indicates whether the element contains a disguised password. | |
|
Read-only |
Indicates whether the element is required to be filled out on a form. | |
|
Read-only |
Retrieves the description of the status of an item in an element. | |
|
Read-only |
Retrieves a description of the type of UI item represented by the element. | |
|
Read-only |
Retrieves the element that contains the text label for this element. | |
|
Read-only |
Retrieves a localized description of the control type of the element. | |
|
Read-only |
Retrieves the name of the element. | |
|
Read-only |
Retrieves the window handle of the element. | |
|
Read-only |
Retrieves a value that indicates the orientation of the element. | |
|
Read-only |
Retrieves the identifier of the process that hosts the element. | |
|
Read-only |
Retrieves a description of the provider for this element. |
Requirements
|
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista, Windows XP with SP3 and Platform Update for Windows Vista [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008, Windows Server 2003 with SP2 and Platform Update for Windows Server 2008 [desktop apps only] |
|
Header |
|
|
IDL |
|
|
DLL |
|
|
IID |
IID IID_IUIAutomationElement is defined as d22108aa-8ac5-49a5-837b-37bbb3d7591e |
See also