AutomationElement.Cached Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets the cached UI Automation property values for this AutomationElement object.

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

public AutomationElement.AutomationElementInformation Cached { get; }

Property Value

Type: System.Windows.Automation.AutomationElement.AutomationElementInformation

A structure containing the cached property values for the AutomationElement.

Exception Condition

There are no cached properties.


The UI for the AutomationElement no longer exists.

The accessors for UI Automation properties are represented as properties of the structure returned by Cached. You do not need to retrieve the structure; you can access its members directly, as in the example below. For specific information on the properties available and their use, see AutomationElement.AutomationElementInformation.

To get the current value of UI Automation properties on this element use the Current property.

The following example shows how the Name property can be cached and then retrieved by using the Cached property.

/// <summary>
/// Gets a list box element and caches the Name property of its children (the list items).
/// </summary>
/// <param name="elementMain">The UI Automation element for the parent window.</param>
void CachePropertiesWithScope(AutomationElement elementMain)
    AutomationElement elementList;

    // Set up the CacheRequest.
    CacheRequest cacheRequest = new CacheRequest();
    cacheRequest.TreeScope = TreeScope.Element | TreeScope.Children;

    // Activate the CacheRequest and get the element. Note that the scope of the CacheRequest
    // is in relation to the object being retrieved: the list box and its children are 
    // cached, not the main window and its children.
    using (cacheRequest.Activate())
        // Load the list element and cache the specified properties for its descendants.
        Condition cond = new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.List);
        elementList = elementMain.FindFirst(TreeScope.Children, cond);
    if (elementList == null) return;

    // The following illustrates that the children of the list are in the cache.
    foreach (AutomationElement listItem in elementList.CachedChildren)

    // The following call raises an exception, because the IsEnabled property was not cached.
    /*** Console.WriteLine(listItem.Cached.IsEnabled); ***/

    // The following illustrates that because the list box itself was cached, it is now
    // available as the CachedParent of each list item.
    AutomationElement child = elementList.CachedChildren[0];

.NET Framework
Available since 3.0
Return to top