IUIAutomationTreeWalker interface (uiautomationclient.h)
Exposes properties and methods that UI Automation client applications use to view and navigate the UI Automation elements on the desktop.
Inheritance
The IUIAutomationTreeWalker interface inherits from the IUnknown interface. IUIAutomationTreeWalker also has these types of members:
Methods
The IUIAutomationTreeWalker interface has these methods.
| IUIAutomationTreeWalker::get_Condition Retrieves the condition that defines the view of the UI Automation tree. |
| IUIAutomationTreeWalker::GetFirstChildElement Retrieves the first child element of the specified UI Automation element. |
| IUIAutomationTreeWalker::GetFirstChildElementBuildCache Retrieves the first child element of the specified UI Automation element, and caches properties and control patterns. |
| IUIAutomationTreeWalker::GetLastChildElement Retrieves the last child element of the specified UI Automation element. |
| IUIAutomationTreeWalker::GetLastChildElementBuildCache Retrieves the last child element of the specified UI Automation element, and caches properties and control patterns. |
| IUIAutomationTreeWalker::GetNextSiblingElement Retrieves the next sibling element of the specified UI Automation element. |
| IUIAutomationTreeWalker::GetNextSiblingElementBuildCache Retrieves the next sibling element of the specified UI Automation element, and caches properties and control patterns. |
| IUIAutomationTreeWalker::GetParentElement Retrieves the parent element of the specified UI Automation element. |
| IUIAutomationTreeWalker::GetParentElementBuildCache Retrieves the parent element of the specified UI Automation element, and caches properties and control patterns. |
| IUIAutomationTreeWalker::GetPreviousSiblingElement Retrieves the previous sibling element of the specified UI Automation element. |
| IUIAutomationTreeWalker::GetPreviousSiblingElementBuildCache Retrieves the previous sibling element of the specified UI Automation element, and caches properties and control patterns. |
| IUIAutomationTreeWalker::NormalizeElement Retrieves the ancestor element nearest to the specified Microsoft UI Automation element in the tree view. |
| IUIAutomationTreeWalker::NormalizeElementBuildCache Retrieves the ancestor element nearest to the specified Microsoft UI Automation element in the tree view, prefetches the requested properties and control patterns, and stores the prefetched items in the cache. |
Remarks
UI Automation clients view the elements on the desktop as a set of IUIAutomation objects arranged in a tree structure. Using the IUIAutomationTreeWalker interface, a client application can navigate by selecting a view of the tree and stepping from one element to another in a specified direction using methods such as GetFirstChildElement and GetNextSiblingElement.
Navigating the tree using IUIAutomationTreeWalker can result in cross-process calls and is not as efficient as locating an element using the IUIAutomationElement::FindAll or IUIAutomationElement::FindFirst methods.
If your client application might try to find elements in its own user interface, you must make all UI Automation calls on a separate thread.
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) |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for