Platforms to show: All Mac Windows Linux Cross-Platform

Back to UIAutomationElementMBS class.

Next items

UIAutomationElementMBS.CachedAcceleratorKey as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached accelerator key for the element.

(Read only property)

UIAutomationElementMBS.CachedAccessKey as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached access key character for the element.

An access key is a character in the text of a menu, menu item, or label of a control such as a button that activates the attached menu function. For example, the letter "O" is often used to invoke the Open file common dialog box from a File menu. Microsoft UI Automation elements that have the access key property set always implement the Invoke control pattern.
(Read only property)

UIAutomationElementMBS.CachedAnnotationObjects as UIAutomationElementArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Returns the cached list of annotation objects associated with this element, such as comment, header, footer, and so on.

(Read only property)

UIAutomationElementMBS.CachedAriaProperties as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached Accessible Rich Internet Applications (ARIA) properties of the element.

(Read only property)

UIAutomationElementMBS.CachedAriaRole as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached Accessible Rich Internet Applications (ARIA) role of the element.

(Read only property)

UIAutomationElementMBS.CachedAutomationId as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached Microsoft UI Automation identifier of the element.

The UI Automation identifier is unique among sibling elements in a container, and is the same in all instances of the application.
(Read only property)

UIAutomationElementMBS.CachedChildren as UIAutomationElementArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached child elements of this UI Automation element.

The view of the returned collection is determined by the TreeFilter property of the UIAutomationCacheRequestMBS that was active when this element was obtained.

Children are cached only if the scope of the cache request included TreeScopeSubtree, TreeScopeChildren, or TreeScopeDescendants.

If the cache request specified that children were to be cached at this level, but there are no children, the value of this property is 0. However, if no request was made to cache children at this level, an attempt to retrieve the property returns an error.
(Read only property)

Some examples using this property:

UIAutomationElementMBS.CachedClassName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached class name of the element.

(Read only property)

Some examples using this property:

UIAutomationElementMBS.CachedControllerFor as UIAutomationElementArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached array of UI Automation elements for which this element serves as the controller.

(Read only property)

UIAutomationElementMBS.CachedControlType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates the control type of the element.

Control types describe a known interaction model for UI Automation elements without relying on a localized control type or combination of complex logic rules. This property cannot change at run time unless the control supports the UIAutomationMultipleViewPatternMBS interface. An example is the Win32 ListView control, which can change from a data grid to a list, depending on the current view.
(Read only property)

Some examples using this property:

UIAutomationElementMBS.CachedCulture as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates the culture associated with the element.

(Read only property)

UIAutomationElementMBS.CachedDescribedBy as UIAutomationElementArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached array of elements that describe this element.

This property maps to the Accessible Rich Internet Applications (ARIA) describedby property.
(Read only property)

UIAutomationElementMBS.CachedFlowsFrom as UIAutomationElementArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached array of elements that indicate the reading order before the current element.

This property maps to the Microsoft Accessible Rich Internet Applications (ARIA) x-ms-aria-flowfrom property.
(Read only property)

UIAutomationElementMBS.CachedFlowsTo as UIAutomationElementArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached array of elements that indicate the reading order after the current element.

This property maps to the Accessible Rich Internet Applications (ARIA) flowto property.
(Read only property)

UIAutomationElementMBS.CachedFrameworkId as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached name of the underlying UI framework associated with the element.

(Read only property)

UIAutomationElementMBS.CachedFullDescription as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Gets the cached full description of the automation element.

Requires Windows 10, version 1703 or later.
(Read only property)

UIAutomationElementMBS.CachedHasKeyboardFocus as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
A cached value that indicates whether the element has keyboard focus.

(Read only property)

UIAutomationElementMBS.CachedHeadingLevel as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Gets the cached heading level of the automation element.

For Windows 10, version 1803 or newer.
(Read only property)

UIAutomationElementMBS.CachedHelpText as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached help text for the element.

This information is typically obtained from ToolTips.
(Read only property)

UIAutomationElementMBS.CachedIsContentElement as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
A cached value that indicates whether the element is a content element.

A content element contains data that is presented to the user. Examples of content elements are the items in a list box or a button in a dialog box. Non-content elements, also called peripheral elements, are typically used to manipulate the content in a composite control; for example, the button on a drop-down control.
(Read only property)

UIAutomationElementMBS.CachedIsControlElement as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates whether the element is a control element.

Controls are elements in the UI that display information, or that can be manipulated by the user to perform an action.
(Read only property)

UIAutomationElementMBS.CachedIsDataValidForForm as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates whether the element contains valid data for the form.

(Read only property)

UIAutomationElementMBS.CachedIsDialog as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached dialog window indicator for the element.

When the CachedIsDialog property is TRUE, a client application can assume the cached window is a dialog.

For Windows 10 Build 20348 or later.
(Read only property)

UIAutomationElementMBS.CachedIsEnabled as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates whether the element is enabled.

(Read only property)

UIAutomationElementMBS.CachedIsKeyboardFocusable as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates whether the element can accept keyboard focus.

(Read only property)

UIAutomationElementMBS.CachedIsOffscreen as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates whether the element is off-screen.

(Read only property)

UIAutomationElementMBS.CachedIsPassword as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates whether the element contains a disguised password.

This property enables applications such as screen-readers to determine whether the text content of a control should be read aloud.
(Read only property)

UIAutomationElementMBS.CachedIsPeripheral as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached peripheral UI indicator for the element.

Peripheral UI appears and supports user interaction, but does not take keyboard focus when it appears. Examples of peripheral UI includes popups, flyouts, context menus, or floating notifications.

When the IsPeripheral property is TRUE, a client application can't assume that focus was taken by the element even if it's currently keyboard-interactive.

This property is relevant for these control types:

  • ControlTypeIdGroup
  • ControlTypeIdMenu
  • ControlTypeIdPane
  • ControlTypeIdToolBar
  • ControlTypeIdToolTip
  • ControlTypeIdWindow
  • ControlTypeIdCustom
The appearance of peripheral UI often triggers one of these events, if the peripheral UI supports one of the relevant patterns:
  • WindowOpened (EventIdWindowWindowOpened)
  • MenuOpened (EventIdMenuOpened)
  • ToolTipOpened (EventIdToolTipOpened)
(Read only property)

UIAutomationElementMBS.CachedIsRequiredForForm as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates whether the element is required to be filled out on a form.

(Read only property)

UIAutomationElementMBS.CachedItemStatus as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached description of the status of an item within an element.

This property enables a client to ascertain whether an element is conveying status about an item. For example, an item associated with a contact in a messaging application might be "Busy" or "Connected"
(Read only property)

UIAutomationElementMBS.CachedItemType as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached string that describes the type of item represented by the element.

This property is used to obtain information about items in a list, tree view, or data grid. For example, an item in a file directory view might be a "Document File" or a "Folder".
(Read only property)

UIAutomationElementMBS.CachedLabeledBy as UIAutomationElementMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached element that contains the text label for this element.

This property could be used to retrieve, for example, the static text label for a combo box.
This property maps to the Accessible Rich Internet Applications (ARIA) labeledby property.
(Read only property)

UIAutomationElementMBS.CachedLandmarkType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Gets the cached landmark type ID for the automation element.

(Read only property)

UIAutomationElementMBS.CachedLevel as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Returns the cached 1-based integer for the level (hierarchy) for the element.

(Read only property)

UIAutomationElementMBS.CachedLiveSetting as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates the type of notifications, if any, that the element sends when the content of the element changes.

This property maps to the Accessible Rich Internet Applications (ARIA) live property.

The LiveSetting property is supported by provider elements that are part of a live region. When the content of a live region changes, the provider element can raise a notification. A client application determines whether to notify the user of the changes based on the value of the LiveSetting property.
(Read only property)

UIAutomationElementMBS.CachedLocalizedControlType as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached localized description of the control type of the element.

(Read only property)

UIAutomationElementMBS.CachedLocalizedLandmarkType as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Gets a string containing the cached localized landmark type for the automation element.

(Read only property)

UIAutomationElementMBS.CachedName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached name of the element.

The name of an element can be used to find the element in the element tree when the automation ID property is not supported on the element.
(Read only property)

UIAutomationElementMBS.CachedNativeWindowHandle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached window handle of the element.

(Read only property)

UIAutomationElementMBS.CachedOptimizeForVisualContent as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates whether the provider exposes only elements that are visible.

A value of TRUE indicates that the provider optimizes for visual content, while FALSE indicates that the provider optimizes for virtual content.
(Read only property)

UIAutomationElementMBS.CachedOrientation as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached value that indicates the orientation of the element.

This property is supported by controls such as scroll bars and sliders that can have either a vertical or a horizontal orientation.
(Read only property)

UIAutomationElementMBS.CachedParent as UIAutomationElementMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves from the cache the parent of this UI Automation element.

(Read only property)

UIAutomationElementMBS.CachedPositionInSet as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Returns the cached 1-based integer for the ordinal position in the set for the element.

(Read only property)

UIAutomationElementMBS.CachedProcessId as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the cached ID of the process that hosts the element.

(Read only property)

Some examples using this property:

UIAutomationElementMBS.CachedProviderDescription as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves a cached description of the provider for this element.

(Read only property)

UIAutomationElementMBS.CachedSizeOfSet as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Returns the cached 1-based integer for the size of the set where the element is located.

(Read only property)

UIAutomationElementMBS.CurrentAcceleratorKey as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the accelerator key for the element.

(Read only property)

UIAutomationElementMBS.CurrentAccessKey as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Retrieves the access key character for the element.

An access key is a character in the text of a menu, menu item, or label of a control such as a button that activates the attached menu function. For example, the letter "O" is often used to invoke the Open file common dialog box from a File menu. Microsoft UI Automation elements that have the access key property set always implement the Invoke control pattern.
(Read only property)

UIAutomationElementMBS.CurrentAnnotationObjects as UIAutomationElementArrayMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property UIAutomation MBS WinFrameworks Plugin 26.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Returns the current list of annotation objects associated with this element, such as comment, header, footer, and so on.

(Read only property)

Next items

The items on this page are in the following plugins: MBS WinFrameworks Plugin.


The biggest plugin in space...