Back to Devexpress

TdxAutomationElementSettings Class

vcl-dxuiaclasses-d3f6c81d.md

latest9.4 KB
Original Source

TdxAutomationElementSettings Class

Stores UI Automation tree-related settings for a DevExpress control/UI element.

Declaration

delphi
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: NameTypeValueDescription (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:

Type

Unchangeable – Depends on the control/UI element class.

Refer to the following topic for detailed information on control types: UI Automation Control Types Overview.

ValueCorresponds 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 | NameSpecify 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 | IsControlElementSpecify if the control/UI element belong to content and control views (subsets) of the UI Automation tree.

UI Automation Events

OnCalculatePropertyAllows you to modify calculated UIA node property values depending on certain conditions.OnInitializePropertiesAllows you to initialize individual UIA node properties manually.

General-Purpose API Members

Assign | AssignToCopy 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.AutomationProvides access to bar item UI Automation and accessibility-related settings.

Data Grid

TcxCustomGrid.AutomationProvides access to data grid UI Automation and accessibility-related settings.

Editors

TcxButtonGroupItem.AutomationProvides access to the button’s UI Automation and accessibility-related settings.TcxCustomButton.AutomationProvides access to button UI Automation and accessibility-related settings.TcxCustomEditButton.AutomationProvides access to the editor button UI Automation and accessibility-related settings.TcxCustomEditProperties.AutomationProvides access to editor UI Automation and accessibility-related settings.TcxCustomListBox.AutomationTcxRadioButton.AutomationProvides access to radio button UI Automation and accessibility-related settings.TdxCustomTreeView.AutomationProvides access to tree view UI Automation and accessibility-related settings.

Layout Control

TdxCustomLayoutControl.AutomationProvides access to layout control UI Automation and accessibility-related settings.TdxCustomLayoutItem.AutomationProvides access to layout item/group UI Automation and accessibility-related settings.

Navigation Bar

TdxNavBarCustomItem.AutomationProvides access to UI Automation and accessibility-related settings for the navigation bar item.

Miscellaneous Controls

TdxCustomPanel.AutomationProvides access to panel UI Automation and accessibility-related settings.

Terminal TdxAutomationElementSettings Class Descendants

The following list contains control-specific UI automation setting classes:

TdxGridColumnAutomationSettingsStores UI Automation tree-related settings for a grid column.TdxGridTableViewAutomationSettingsStores UI Automation tree-related settings for a grid Table View.TdxTreeListAutomationSettingsStores UI Automation tree-related settings for a Tree List control.

Inheritance

TObject TPersistent TInterfacedPersistent TcxInterfacedPersistent TdxAutomationElementSettings

See Also

Accessibility Support

TdxUIADefaultSettings Class

TdxAutomationElementSettings Members

dxUIAClasses Unit