IUIAutomationCacheRequest::put_AutomationElementMode method (uiautomationclient.h)

Article
02/22/2024

Indicates whether returned elements contain full references to the underlying UI, or only cached information.

This property is read/write.

Syntax

HRESULT put_AutomationElementMode(
  AutomationElementMode mode
);

Parameters

mode

Return value

None

Remarks

AutomationElementMode_Full is the default value, and specifies that returned elements contain a full reference to the underlying UI. AutomationElementMode_None specifies that the returned elements have no reference to the underlying UI, and contain only cached information.

Certain operations on elements, including GetCurrentPropertyValue, and SetFocus, require a full reference; attempting to perform these on an element that has none results in an error.

Using AutomationElementMode_None can be more efficient when only properties are needed, as it avoids the overhead involved in setting up full references.

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)

Share via