AutomationElement.GetUpdatedCache Method (CacheRequest)


Retrieves a new AutomationElement with an updated cache.

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

Public Function GetUpdatedCache (
	request As CacheRequest
) As AutomationElement


Type: System.Windows.Automation.CacheRequest

The patterns and properties to include in the updated cache.

Return Value

Type: System.Windows.Automation.AutomationElement

A new AutomationElement that has an updated cache.

The original AutomationElement is unchanged. GetUpdatedCache returns a new AutomationElement, that refers to the same user interface (UI) and has the same RuntimeIdProperty.

The following example demonstrates how a cache might be updated whenever the selection in a combo box changes.

Private comboCacheRequest As CacheRequest
Private selectHandler As AutomationEventHandler
Private elementCombo As AutomationElement
Private selectedItem As AutomationElement

''' <summary>
''' Retrieves a combo box automation element, caches a pattern and a property,
''' and registers the event handler.
''' </summary>
''' <param name="elementAppWindow">The element for the parent window.</param>
Private Sub SetupComboElement(ByVal elementAppWindow As AutomationElement)
    ' Set up the CacheRequest.
    comboCacheRequest = New CacheRequest()
    comboCacheRequest.TreeScope = TreeScope.Element Or TreeScope.Descendants

    ' Activate the CacheRequest and get the element.
    Using comboCacheRequest.Activate()
        ' Load the combo box element and cache the specified properties and patterns.
        Dim propCondition As New PropertyCondition(AutomationElement.AutomationIdProperty, "comboBox1", PropertyConditionFlags.IgnoreCase)
        elementCombo = elementAppWindow.FindFirst(TreeScope.Descendants, propCondition)

        ' Get the list from the combo box.
        Dim propCondition1 As New PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.List)
        Dim listElement As AutomationElement = elementCombo.FindFirst(TreeScope.Children, propCondition1)

        ' Register for ElementSelectedEvent on list items.
        selectHandler = New AutomationEventHandler(AddressOf OnListItemSelect)
        If (listElement IsNot Nothing) Then
            Automation.AddAutomationEventHandler(SelectionItemPattern.ElementSelectedEvent, listElement, _
            TreeScope.Children, selectHandler)
        End If
    End Using

End Sub 'SetupComboElement

''' <summary>
''' Handle ElementSelectedEvent on items in the combo box.
''' </summary>
''' <param name="src">Object that raised the event.</param>
''' <param name="e">Event arguments.</param>
Private Sub OnListItemSelect(ByVal src As Object, ByVal e As AutomationEventArgs)
    ' Update the cache.
    Dim updatedElement As AutomationElement = elementCombo.GetUpdatedCache(comboCacheRequest)

    ' Retrieve the pattern and the selected item from the cache. This code is here only to 
    ' demonstrate that the current selection can now be retrieved from the cache. In an application,
    ' this would be done only when the information was needed.
    Dim pattern As SelectionPattern = _
        DirectCast(updatedElement.GetCachedPattern(SelectionPattern.Pattern), SelectionPattern)
    Dim selectedItems As AutomationElement() = pattern.Cached.GetSelection()
    selectedItem = selectedItems(0)

End Sub 'OnListItemSelect

.NET Framework
Available since 3.0
Return to top