TdxGridColumnAutomationSettings Class
Stores UI Automation tree-related settings for a grid column.
Declaration
TdxGridColumnAutomationSettings = class(
TdxAutomationElementSettings
)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.
UI Automation Tree Views
Control and Content Views are subsets of an entire UI Automation tree (Raw View) designed to limit UI element visibility to third-party assistive tools depending on usage scenarios.
Control View
The control view includes all interactive UI elements (buttons, editor boxes, and other elements that can accept input focus) and visual elements that form the logical structure of the UI (headers, toolbars, menus, etc.). The control view does not include decorative non-interactive UI elements.
The UI control type (terminal class) defines whether the particular DevExpress UI control/UI element is initially included in the control view. You can set the IsControlElement property to bTrue or bFalse to explicitly include/exclude the control/UI element to/from the control view of the UI Automation tree.
Content View
The content view is a subset of the control view. The content view is designed to include only the UI elements that display meaningful information in a user interface, including UI elements that can receive focus. For example, the content view lists all drop-down menu item values because users can select them.
The UI control type (terminal class) defines whether a DevExpress UI control/UI element is initially included in the content view. You can set the IsContentElement property to bTrue or bFalse to explicitly include/exclude the control/UI element to/from the content view of the UI Automation tree.
Main API Members
The list below outlines key members of the TcxGridColumnAutomationSettings class. These members allow you to configure column content mapping to a node in a UI Automation tree if the dxUIAutomationEnabled global variable is set to True.
UI Automation Settings
- AutomationId
- Allows you to specify a localization/context-independent ID for the control/UI element in the UI Automation tree. This property is particularly useful for test automation scripts.
- DescribedBy | NamedBy
Specify controls used as sources of the current column 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 name and description for the column in the UI Automation tree. Third-party UIA clients read these properties when a cell within the column accepts focus.
- IncludeCellInRowName
- Specifies if the column value is included in UIA information for the focused row. This option can be useful if column values help users to identify the focused row.
- IsContentElement | IsControlElement
- Specify if the column belongs to content and control views (subsets) of the UI Automation tree.
UI Automation Events
- OnCalculateProperty
- Allows you to modify calculated UIA node property values for the current column depending on certain conditions.
- OnInitializeProperties
- Allows you to initialize individual UIA node properties for the current column.
General-Purpose API Members
- Assign | AssignTo
- Copy UI Automation tree settings between grid columns.
Direct TdxGridColumnAutomationSettings Class Reference
The TcxCustomGridColumn.Automation property references a TdxGridColumnAutomationSettings object.