UIAutomationTreeWalkerMBS.Constructor(Automation as UIAutomationMBS, condition as UIAutomationConditionMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves a tree walker object that can be used to traverse the Microsoft UI Automation tree.

UIAutomationTreeWalkerMBS.Destructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

The destructor.

UIAutomationTreeWalkerMBS.FirstChildElement(element as UIAutomationElementMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the first child element of the specified UI Automation element.

element: the element for which to retrieve the first child.

Returns the first child element or nil if there is no child element.

An element can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the first child element will be returned as the first child on subsequent passes.

UIAutomationTreeWalkerMBS.FirstChildElementBuildCache(element as UIAutomationElementMBS, cacheRequest as UIAutomationCacheRequestMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the first child element of the specified UI Automation element, and caches properties and control patterns.

element: the element for which to retrieve the first child.
cacheRequest: a cache request that specifies the properties and control patterns to cache on the returned element.

Returns the first child element or nil if there is no child element.

An element can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the first child element will be returned as the first child on subsequent passes.

UIAutomationTreeWalkerMBS.LastChildElement(element as UIAutomationElementMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the last child element of the specified UI Automation element.

Element: The element for which to retrieve the last child.

An element can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the last child element will be returned as the last child on subsequent passes.

UIAutomationTreeWalkerMBS.LastChildElementBuildCache(element as UIAutomationElementMBS, cacheRequest as UIAutomationCacheRequestMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the last child element of the specified UI Automation element, and caches properties and control patterns.

Element: the element for which to retrieve the last child.
cacheRequest: a cache request that specifies the properties and control patterns to cache on the returned element.

Receives the last child element, or nil if there is no child element.

An element can have additional child elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the last child element will be returned as the last child on subsequent passes.

UIAutomationTreeWalkerMBS.NextSiblingElement(element as UIAutomationElementMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the next sibling element of the specified UI Automation element.

Element: the element for which to retrieve the next sibling.

Returns the next sibling element, or nil if there is no sibling element.

An element can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes.

UIAutomationTreeWalkerMBS.NextSiblingElementBuildCache(element as UIAutomationElementMBS, cacheRequest as UIAutomationCacheRequestMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the next sibling element of the specified UI Automation element, and caches properties and control patterns.

Element: the element for which to retrieve the next sibling.
cacheRequest: a cache request that specifies the properties and control patterns to cache on the returned element.

Returns the next sibling element, or nil if there is no sibling element.

An element can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the next sibling element will be returned as the next sibling on subsequent passes.

UIAutomationTreeWalkerMBS.NormalizeElement(element as UIAutomationElementMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the ancestor element nearest to the specified Microsoft UI Automation element in the tree view.

element: the element from which to start the normalization.

Returns the ancestor element nearest to the specified element in the tree view.

The element is normalized by navigating up the ancestor chain in the tree until an element that satisfies the view condition (specified by a previous call to Condition) is reached. But first, the passed element is tested to see if it matches a normalization condition. If so, the passed element is returned, even though it is not an ancestor.

The method returns UIA_E_ELEMENTNOTAVAILABLE if no matching element has been found.

This method is useful for applications that obtain references to UI Automation elements by hit-testing. The application might want to work only with specific types of elements, and can use Normalize to make sure that no matter what element is initially retrieved (for example, when a scroll bar gets the input focus), only the element of interest (such as a content element) is ultimately retrieved.

UIAutomationTreeWalkerMBS.NormalizeElementBuildCache(element as UIAutomationElementMBS, cacheRequest as UIAutomationCacheRequestMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

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.

element: the element from which to start the normalization.
cacheRequest: a cache request that specifies the properties and control patterns to cache on the returned element.

Return the ancestor element nearest to the specified element in the tree view.

The element is normalized by navigating up the ancestor chain in the tree until an element that satisfies the view condition (specified by a previous call to Condition) is reached. If the root element is reached, the root element is returned, even if it does not satisfy the view condition.

This method is useful for applications that obtain references to UI Automation elements by hit-testing. The application might want to work only with specific types of elements, and can use NormalizeElement to make sure that no matter what element is initially retrieved (for example, when a scroll bar gets the input focus), only the element of interest (such as a content element) is ultimately retrieved.

UIAutomationTreeWalkerMBS.ParentElement(element as UIAutomationElementMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the parent element of the specified UI Automation element.

Element: the element for which to retrieve the parent.

Returns the parent element, or nil if there is no parent element.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the parent element will be returned as the parent on subsequent passes.

UIAutomationTreeWalkerMBS.ParentElementBuildCache(element as UIAutomationElementMBS, cacheRequest as UIAutomationCacheRequestMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the parent element of the specified UI Automation element, and caches properties and control patterns.

Element: the element for which to retrieve the parent.
cacheRequest: a cache request that specifies the properties and control patterns to cache on the returned element.

Returns the parent element, or nil if there is no parent element.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the parent element will be returned as the parent on subsequent passes.

UIAutomationTreeWalkerMBS.PreviousSiblingElement(element as UIAutomationElementMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the previous sibling element of the specified UI Automation element.

Element: the element for which to retrieve the previous sibling.

Returns the previous sibling element, or nil if there is no sibling element.

An element can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the previous sibling element will be returned as the previous sibling on subsequent passes.

UIAutomationTreeWalkerMBS.PreviousSiblingElementBuildCache(element as UIAutomationElementMBS, cacheRequest as UIAutomationCacheRequestMBS) as UIAutomationElementMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	UIAutomation	MBS WinFrameworks Plugin	26.2	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Retrieves the previous sibling element of the specified UI Automation element, and caches properties and control patterns.

element: the element for which to retrieve the previous sibling.
cacheRequest: a cache request that specifies the properties and control patterns to cache on the returned element.

Returns the previous sibling element, or nil if there is no sibling element.

An element can have additional sibling elements that do not match the current view condition and thus are not returned when navigating the element tree.

The structure of the Microsoft UI Automation tree changes as the visible UI elements on the desktop change. It is not guaranteed that an element returned as the previous sibling element will be returned as the previous sibling on subsequent passes.