TdxAutomationElementSettings Class
Stores UI Automation tree-related settings for a DevExpress control/UI element.
Declaration
TdxAutomationElementSettings = class(
TcxInterfacedPersistent
)Remarks
UI Automation-based assistive tools (such as Microsoft Narrator) rely on the Microsoft UI Automation (UIA) framework to obtain information about UI elements in an application.
UIA Node Properties and Clients
Different third-party assistive tools (UI Automation clients) may read UIA node properties in a different order.
For example, Microsoft Narrator reads these properties as follows: Name → Type → Value → Description (if defined).
Type and Value Properties
You can use Name and Description properties to change corresponding UIA node properties for the control/UI element. Type and Value properties depend on the control/UI element type and state:
TypeUnchangeable – Depends on the control/UI element class.
Refer to the following topic for detailed information on control types: UI Automation Control Types Overview.
Value- Corresponds to the current control/editor value. Different control types use different value sources.
Main API Members
The list below outlines key members of the TdxAutomationElementSettings class. These members determine how a supported DevExpress control/UI element maps to a node in a UI Automation tree if the dxUIAutomationEnabled global variable is set to True.
UI Automation Settings
- DescribedBy | NamedBy
Specify controls used as sources of the current DevExpress control/UI element’s name and description as a node in a UI Automation tree.
Note
DescribedBy and NamedBy properties are in effect only if corresponding properties (Description and Name) are unspecified.
- Description | Name
- Specify the control/UI element’s name and description in the UI Automation tree. Third-party UIA clients read these properties when the control/UI element accepts focus.
- IsContentElement | IsControlElement
- Specify if the control/UI element belong to content and control views (subsets) of the UI Automation tree.
UI Automation Events
- OnCalculateProperty
- Allows you to modify calculated UIA node property values depending on certain conditions.
- OnInitializeProperties
- Allows you to initialize individual UIA node properties manually.
General-Purpose API Members
- Assign | AssignTo
- Copy UI Automation tree settings between supported DevExpress controls/UI elements.
Direct TdxAutomationElementSettings Class References
All public API members in this section reference a TdxAutomationElementSettings object.
Bars
- TdxBarItem.Automation
- Provides access to bar item UI Automation and accessibility-related settings.
Data Grid
- TcxCustomGrid.Automation
- Provides access to data grid UI Automation and accessibility-related settings.
- TcxCustomGridTableItem.Automation
- Provides access to data item UI Automation and accessibility-related settings.
Editors
- TcxCustomButton.Automation
- Provides access to button UI Automation and accessibility-related settings.
- TcxCustomEditButton.Automation
- Provides access to the editor button UI Automation and accessibility-related settings.
- TcxCustomEditProperties.Automation
- Provides access to editor UI Automation and accessibility-related settings.
- TcxCustomListBox.Automation
- TcxGroupBox.Automation
- Provides access to group box UI Automation and accessibility-related settings.
- TcxRadioButton.Automation
- Provides access to radio button UI Automation and accessibility-related settings.
- TcxRadioGroupItem.Automation
- Provides access to the radio group item’s UI Automation and accessibility settings.
- TdxCustomTreeView.Automation
- Provides access to tree view UI Automation and accessibility-related settings.
Layout Control
- TdxCustomLayoutControl.Automation
- Provides access to layout control UI Automation and accessibility-related settings.
- TdxCustomLayoutItem.Automation
- Provides access to layout item/group UI Automation and accessibility-related settings.
Navigation Bar
- TdxNavBarCustomItem.Automation
- Provides access to UI Automation and accessibility-related settings for the navigation bar item.
Miscellaneous Controls
- TdxCustomPanel.Automation
- Provides access to panel UI Automation and accessibility-related settings.