Expand Minimize

IUIAutomationElement interface

Exposes methods and properties for a UI Automation element, which represents a UI item.

When to implement

UI Automation client applications do not implement IUIAutomationElement.

Members

The IUIAutomationElement interface inherits from the IUnknown interface. IUIAutomationElement also has these types of members:

Methods

The IUIAutomationElement interface has these methods.

MethodDescription
BuildUpdatedCache

Retrieves a new UI Automation element with an updated cache.

FindAll

Returns all UI Automation elements that satisfy the specified condition.

FindAllBuildCache

Returns all UI Automation elements that satisfy the specified condition, prefetches the requested properties and control patterns, and stores the prefetched items in the cache.

FindFirst

Retrieves the first child or descendant element that matches the specified condition.

FindFirstBuildCache

Retrieves the first child or descendant element that matches the specified condition, prefetches the requested properties and control patterns, and stores the prefetched items in the cache.

GetCachedChildren

Retrieves the cached child elements of this UI Automation element.

GetCachedParent

Retrieves from the cache the parent of this UI Automation element.

GetCachedPattern

Retrieves from the cache the IUnknown interface of the specified control pattern of this UI Automation element.

GetCachedPatternAs

Retrieves the control pattern interface of the specified pattern from the cache of this UI Automation element.

GetCachedPropertyValue

Retrieves a property value from the cache for this UI Automation element.

GetCachedPropertyValueEx

Retrieves a property value from the cache for this UI Automation element, optionally ignoring any default value.

GetClickablePoint

Retrieves a point on the element that can be clicked.

GetCurrentPattern

Retrieves the IUnknown interface of the specified control pattern on this UI Automation element.

GetCurrentPatternAs

Retrieves the control pattern interface of the specified pattern on this UI Automation element.

GetCurrentPropertyValue

Retrieves the current value of a property for this UI Automation element.

GetCurrentPropertyValueEx

Retrieves a property value for this UI Automation element, optionally ignoring any default value.

GetRuntimeId

Retrieves the unique identifier assigned to the UI element.

SetFocus

Sets the keyboard focus to this UI Automation element.

 

Properties

The IUIAutomationElement interface has these properties.

PropertyAccess typeDescription

CachedAcceleratorKey

Read-only

Retrieves the cached accelerator key for the element.

CachedAccessKey

Read-only

Retrieves the cached access key character for the element.

CachedAriaProperties

Read-only

Retrieves the cached ARIA properties of the element.

CachedAriaRole

Read-only

Retrieves the cached ARIA role of the element.

CachedAutomationId

Read-only

Retrieves the cached UI Automation identifier of the element.

CachedBoundingRectangle

Read-only

Retrieves the cached coordinates of the rectangle that completely encloses the element.

CachedClassName

Read-only

Retrieves the cached class name of the element.

CachedControllerFor

Read-only

Retrieves a cached array of UI Automation elements for which this element serves as the controller.

CachedControlType

Read-only

Retrieves a cached value that indicates the control type of the element.

CachedCulture

Read-only

Retrieves a cached value that indicates the culture associated with the element.

CachedDescribedBy

Read-only

Retrieves a cached array of elements that describe this element.

CachedFlowsTo

Read-only

Retrieves a cached array of elements that indicate the reading order after the current element.

CachedFrameworkId

Read-only

Retrieves the cached name of the underlying UI framework associated with the element.

CachedHasKeyboardFocus

Read-only

A cached value that indicates whether the element has keyboard focus.

CachedHelpText

Read-only

Retrieves the cached help text for the element.

CachedIsContentElement

Read-only

A cached value that indicates whether the element is a content element.

CachedIsControlElement

Read-only

Retrieves a cached value that indicates whether the element is a control element.

CachedIsDataValidForForm

Read-only

Retrieves a cached value that indicates whether the element contains valid data for the form.

CachedIsEnabled

Read-only

Retrieves a cached value that indicates whether the element is enabled.

CachedIsKeyboardFocusable

Read-only

Retrieves a cached value that indicates whether the element can accept keyboard focus.

CachedIsOffscreen

Read-only

Retrieves a cached value that indicates whether the element is off-screen.

CachedIsPassword

Read-only

Retrieves a cached value that indicates whether the element contains a disguised password.

CachedIsRequiredForForm

Read-only

Retrieves a cached value that indicates whether the element is required to be filled out on a form.

CachedItemStatus

Read-only

Retrieves a cached description of the status of an item within an element.

CachedItemType

Read-only

Retrieves a cached string that describes the type of item represented by the element.

CachedLabeledBy

Read-only

Retrieves the cached element that contains the text label for this element.

CachedLocalizedControlType

Read-only

Retrieves the cached localized description of the control type of the element.

CachedName

Read-only

Retrieves the cached name of the element.

CachedNativeWindowHandle

Read-only

Retrieves the cached window handle of the element.

CachedOrientation

Read-only

Retrieves a cached value that indicates the orientation of the element.

CachedProcessId

Read-only

Retrieves the cached ID of the process that hosts the element.

CachedProviderDescription

Read-only

Retrieves a cached description of the provider for this element.

CurrentAcceleratorKey

Read-only

Retrieves the accelerator key for the element.

CurrentAccessKey

Read-only

Retrieves the access key character for the element.

CurrentAriaProperties

Read-only

Retrieves the ARIA properties of the element.

CurrentAriaRole

Read-only

Retrieves the ARIA role of the element.

CurrentAutomationId

Read-only

Retrieves the UI Automation identifier of the element.

CurrentBoundingRectangle

Read-only

Retrieves the coordinates of the rectangle that completely encloses the element.

CurrentClassName

Read-only

Retrieves the class name of the element.

CurrentControllerFor

Read-only

Retrieves an array of elements for which this element serves as the controller.

CurrentControlType

Read-only

Retrieves the control type of the element.

CurrentCulture

Read-only

Retrieves the culture identifier for the element.

CurrentDescribedBy

Read-only

Retrieves an array of elements that describe this element.

CurrentFlowsTo

Read-only

Retrieves an array of elements that indicates the reading order after the current element.

CurrentFrameworkId

Read-only

Retrieves the name of the underlying UI framework.

CurrentHasKeyboardFocus

Read-only

Indicates whether the element has keyboard focus.

CurrentHelpText

Read-only

Retrieves the help text for the element.

CurrentIsContentElement

Read-only

Indicates whether the element is a content element.

CurrentIsControlElement

Read-only

Indicates whether the element is a control element.

CurrentIsDataValidForForm

Read-only

Indicates whether the element contains valid data for a form.

CurrentIsEnabled

Read-only

Indicates whether the element is enabled.

CurrentIsKeyboardFocusable

Read-only

Indicates whether the element can accept keyboard focus.

CurrentIsOffscreen

Read-only

Indicates whether the element is off-screen.

CurrentIsPassword

Read-only

Indicates whether the element contains a disguised password.

CurrentIsRequiredForForm

Read-only

Indicates whether the element is required to be filled out on a form.

CurrentItemStatus

Read-only

Retrieves the description of the status of an item in an element.

CurrentItemType

Read-only

Retrieves a description of the type of UI item represented by the element.

CurrentLabeledBy

Read-only

Retrieves the element that contains the text label for this element.

CurrentLocalizedControlType

Read-only

Retrieves a localized description of the control type of the element.

CurrentName

Read-only

Retrieves the name of the element.

CurrentNativeWindowHandle

Read-only

Retrieves the window handle of the element.

CurrentOrientation

Read-only

Retrieves a value that indicates the orientation of the element.

CurrentProcessId

Read-only

Retrieves the identifier of the process that hosts the element.

CurrentProviderDescription

Read-only

Retrieves a description of the provider for this element.

 

Requirements

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]

Header

UIAutomationClient.h (include UIAutomation.h)

IDL

UIAutomationClient.idl

DLL

UIAutomationCore.dll

IID

IID IID_IUIAutomationElement is defined as d22108aa-8ac5-49a5-837b-37bbb3d7591e

See also

UI Automation Element Interfaces for Clients

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.