IUIAutomationElement interface (uiautomationclient.h)
Exposes methods and properties for a UI Automation element, which represents a UI item.
Inheritance
The IUIAutomationElement interface inherits from the IUnknown interface. IUIAutomationElement also has these types of members:
Methods
The IUIAutomationElement interface has these methods.
| IUIAutomationElement::BuildUpdatedCache Retrieves a new UI Automation element with an updated cache. |
| IUIAutomationElement::FindAll Returns all UI Automation elements that satisfy the specified condition. |
| IUIAutomationElement::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. |
| IUIAutomationElement::FindFirst Retrieves the first child or descendant element that matches the specified condition. |
| IUIAutomationElement::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. |
| IUIAutomationElement::get_CachedAcceleratorKey Retrieves the cached accelerator key for the element. |
| IUIAutomationElement::get_CachedAccessKey Retrieves the cached access key character for the element. |
| IUIAutomationElement::get_CachedAriaProperties Retrieves the cached Accessible Rich Internet Applications (ARIA) properties of the element. |
| IUIAutomationElement::get_CachedAriaRole Retrieves the cached Accessible Rich Internet Applications (ARIA) role of the element. |
| IUIAutomationElement::get_CachedAutomationId Retrieves the cached Microsoft UI Automation identifier of the element. |
| IUIAutomationElement::get_CachedBoundingRectangle Retrieves the cached coordinates of the rectangle that completely encloses the element. |
| IUIAutomationElement::get_CachedClassName Retrieves the cached class name of the element. |
| IUIAutomationElement::get_CachedControllerFor Retrieves a cached array of UI Automation elements for which this element serves as the controller. |
| IUIAutomationElement::get_CachedControlType Retrieves a cached value that indicates the control type of the element. |
| IUIAutomationElement::get_CachedCulture Retrieves a cached value that indicates the culture associated with the element. |
| IUIAutomationElement::get_CachedDescribedBy Retrieves a cached array of elements that describe this element. |
| IUIAutomationElement::get_CachedFlowsTo Retrieves a cached array of elements that indicate the reading order after the current element. |
| IUIAutomationElement::get_CachedFrameworkId Retrieves the cached name of the underlying UI framework associated with the element. |
| IUIAutomationElement::get_CachedHasKeyboardFocus A cached value that indicates whether the element has keyboard focus. |
| IUIAutomationElement::get_CachedHelpText Retrieves the cached help text for the element. |
| IUIAutomationElement::get_CachedIsContentElement A cached value that indicates whether the element is a content element. |
| IUIAutomationElement::get_CachedIsControlElement Retrieves a cached value that indicates whether the element is a control element. |
| IUIAutomationElement::get_CachedIsDataValidForForm Retrieves a cached value that indicates whether the element contains valid data for the form. |
| IUIAutomationElement::get_CachedIsEnabled Retrieves a cached value that indicates whether the element is enabled. |
| IUIAutomationElement::get_CachedIsKeyboardFocusable Retrieves a cached value that indicates whether the element can accept keyboard focus. |
| IUIAutomationElement::get_CachedIsOffscreen Retrieves a cached value that indicates whether the element is off-screen. |
| IUIAutomationElement::get_CachedIsPassword Retrieves a cached value that indicates whether the element contains a disguised password. |
| IUIAutomationElement::get_CachedIsRequiredForForm Retrieves a cached value that indicates whether the element is required to be filled out on a form. |
| IUIAutomationElement::get_CachedItemStatus Retrieves a cached description of the status of an item within an element. |
| IUIAutomationElement::get_CachedItemType Retrieves a cached string that describes the type of item represented by the element. |
| IUIAutomationElement::get_CachedLabeledBy Retrieves the cached element that contains the text label for this element. |
| IUIAutomationElement::get_CachedLocalizedControlType Retrieves the cached localized description of the control type of the element. |
| IUIAutomationElement::get_CachedName Retrieves the cached name of the element. |
| IUIAutomationElement::get_CachedNativeWindowHandle Retrieves the cached window handle of the element. |
| IUIAutomationElement::get_CachedOrientation Retrieves a cached value that indicates the orientation of the element. |
| IUIAutomationElement::get_CachedProcessId Retrieves the cached ID of the process that hosts the element. |
| IUIAutomationElement::get_CachedProviderDescription Retrieves a cached description of the provider for this element. |
| IUIAutomationElement::get_CurrentAcceleratorKey Retrieves the accelerator key for the element. |
| IUIAutomationElement::get_CurrentAccessKey Retrieves the access key character for the element. |
| IUIAutomationElement::get_CurrentAriaProperties Retrieves the Accessible Rich Internet Applications (ARIA) properties of the element. |
| IUIAutomationElement::get_CurrentAriaRole Retrieves the Accessible Rich Internet Applications (ARIA) role of the element. |
| IUIAutomationElement::get_CurrentAutomationId Retrieves the Microsoft UI Automation identifier of the element. |
| IUIAutomationElement::get_CurrentBoundingRectangle Retrieves the coordinates of the rectangle that completely encloses the element. |
| IUIAutomationElement::get_CurrentClassName Retrieves the class name of the element. |
| IUIAutomationElement::get_CurrentControllerFor Retrieves an array of elements for which this element serves as the controller. |
| IUIAutomationElement::get_CurrentControlType Retrieves the control type of the element. |
| IUIAutomationElement::get_CurrentCulture Retrieves the culture identifier for the element. |
| IUIAutomationElement::get_CurrentDescribedBy Retrieves an array of elements that describe this element. |
| IUIAutomationElement::get_CurrentFlowsTo Retrieves an array of elements that indicates the reading order after the current element. |
| IUIAutomationElement::get_CurrentFrameworkId Retrieves the name of the underlying UI framework. |
| IUIAutomationElement::get_CurrentHasKeyboardFocus Indicates whether the element has keyboard focus. |
| IUIAutomationElement::get_CurrentHelpText Retrieves the help text for the element. |
| IUIAutomationElement::get_CurrentIsContentElement Indicates whether the element is a content element. |
| IUIAutomationElement::get_CurrentIsControlElement Indicates whether the element is a control element. |
| IUIAutomationElement::get_CurrentIsDataValidForForm Indicates whether the element contains valid data for a form. |
| IUIAutomationElement::get_CurrentIsEnabled Indicates whether the element is enabled. |
| IUIAutomationElement::get_CurrentIsKeyboardFocusable Indicates whether the element can accept keyboard focus. |
| IUIAutomationElement::get_CurrentIsOffscreen Indicates whether the element is off-screen. |
| IUIAutomationElement::get_CurrentIsPassword Indicates whether the element contains a disguised password. |
| IUIAutomationElement::get_CurrentIsRequiredForForm Indicates whether the element is required to be filled out on a form. |
| IUIAutomationElement::get_CurrentItemStatus Retrieves the description of the status of an item in an element. |
| IUIAutomationElement::get_CurrentItemType Retrieves a description of the type of UI item represented by the element. |
| IUIAutomationElement::get_CurrentLabeledBy Retrieves the element that contains the text label for this element. |
| IUIAutomationElement::get_CurrentLocalizedControlType Retrieves a localized description of the control type of the element. |
| IUIAutomationElement::get_CurrentName Retrieves the name of the element. |
| IUIAutomationElement::get_CurrentNativeWindowHandle Retrieves the window handle of the element. |
| IUIAutomationElement::get_CurrentOrientation Retrieves a value that indicates the orientation of the element. |
| IUIAutomationElement::get_CurrentProcessId Retrieves the identifier of the process that hosts the element. |
| IUIAutomationElement::get_CurrentProviderDescription Retrieves a description of the provider for this element. |
| IUIAutomationElement::GetCachedChildren Retrieves the cached child elements of this UI Automation element. |
| IUIAutomationElement::GetCachedParent Retrieves from the cache the parent of this UI Automation element. |
| IUIAutomationElement::GetCachedPattern Retrieves from the cache the IUnknown interface of the specified control pattern of this UI Automation element. |
| IUIAutomationElement::GetCachedPatternAs Retrieves the control pattern interface of the specified pattern from the cache of this UI Automation element. |
| IUIAutomationElement::GetCachedPropertyValue Retrieves a property value from the cache for this UI Automation element. |
| IUIAutomationElement::GetCachedPropertyValueEx Retrieves a property value from the cache for this UI Automation element, optionally ignoring any default value. |
| IUIAutomationElement::GetClickablePoint Retrieves a point on the element that can be clicked. |
| IUIAutomationElement::GetCurrentPattern Retrieves the IUnknown interface of the specified control pattern on this UI Automation element. |
| IUIAutomationElement::GetCurrentPatternAs Retrieves the control pattern interface of the specified pattern on this UI Automation element. |
| IUIAutomationElement::GetCurrentPropertyValue Retrieves the current value of a property for this UI Automation element. |
| IUIAutomationElement::GetCurrentPropertyValueEx Retrieves a property value for this UI Automation element, optionally ignoring any default value. |
| IUIAutomationElement::GetRuntimeId Retrieves the unique identifier assigned to the UI element. |
| IUIAutomationElement::SetFocus Sets the keyboard focus to this UI Automation element. |
Requirements
| Requirement | Value |
|---|---|
| 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] |
| Target Platform | Windows |
| Header | uiautomationclient.h (include UIAutomation.h) |