Export (0) Print
Expand All

AutomationElement.FindAll Method

Returns all AutomationElement objects that satisfy the specified condition.

Namespace:  System.Windows.Automation
Assembly:  UIAutomationClient (in UIAutomationClient.dll)

'Declaration
Public Function FindAll ( _
	scope As TreeScope, _
	condition As Condition _
) As AutomationElementCollection

Parameters

scope
Type: System.Windows.Automation.TreeScope

A bitwise combination of values that specifies the scope of the search.

condition
Type: System.Windows.Automation.Condition

The object containing the criteria to match.

Return Value

Type: System.Windows.Automation.AutomationElementCollection
A collection of objects that satisfies the specified condition. If there are no matches, an empty collection is returned.

The scope of the search is relative to the element on which the method is called. Elements are returned in the order in which they were encountered in the tree.

When searching for top-level windows on the desktop, be sure to specify Children in scope, not Descendants. A search through the entire subtree of the desktop could iterate through thousands of items and lead to a stack overflow.

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.

The following example shows how to use FindAll to locate all enabled buttons in a window.

    ''' <summary> 
    ''' Finds all enabled buttons in the specified window element. 
    ''' </summary> 
    ''' <param name="elementWindowElement">An application or dialog window.</param> 
    ''' <returns>A collection of elements that meet the conditions.</returns> 
    Function FindByMultipleConditions(ByVal elementWindowElement As AutomationElement) As AutomationElementCollection
        If elementWindowElement Is Nothing Then 
            Throw New ArgumentException()
        End If 
        Dim conditions As New AndCondition(New PropertyCondition(AutomationElement.IsEnabledProperty, True), New PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Button))

        ' Find all children that match the specified conditions. 
        Dim elementCollection As AutomationElementCollection = elementWindowElement.FindAll(TreeScope.Children, conditions)
        Return elementCollection

    End Function 'FindByMultipleConditions

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft