Skip to main content
BuyLog In
VCL
Search in…
Docs > VCL Controls > Express Cross Platform Library > API Reference > dxUIAClasses > TdxAutomationElementSettings
All docs
V26.1
    • VCL Controls
    What's New
    Installation
    AI-assisted Development
    Express Cross Platform Library
    VCL Template Kit
    Common Features
    General Recommendations
    Global Application Settings
    High DPI and Graphics
    Standalone Tools
    VCL Reports/Dashboards
    Concepts
    How To...
    GitHub Examples
    API Reference
    cxClasses
    cxContainer
    cxControls
    cxCustomCanvas
    cxDateUtils
    cxDrawTextUtils
    cxExport
    cxFormats
    cxGeometry
    cxGraphics
    cxImageList
    cxLibraryConsts
    cxLocalization
    cxLookAndFeelPainters
    cxLookAndFeels
    cxPropertiesStore
    cxScrollBar
    cxStorage
    cxStyles
    dxAI
    dxActions
    dxAnimation
    dxAuthorizationAgents
    dxCalloutPopup
    dxCloudStorage
    dxCloudStorageGoogleDriveProvider
    dxCloudStorageMicrosoftOneDriveProvider
    dxCore
    dxCoreClasses
    dxCoreGraphics
    dxCryptoAPI
    dxCustomFluentDesignForm
    dxCustomHint
    dxCustomPreview
    dxCustomTree
    dxDPIAwareUtils
    dxDateRanges
    dxDocumentLayoutUnitConverter
    dxFading
    dxFontHelpers
    dxForms
    dxFramedControl
    dxGDIPlusAPI
    dxGDIPlusClasses
    dxGallery
    dxGenerics
    dxHashUtils
    dxMeasurementUnits
    dxPanel
    dxPasswordDialog
    dxPrintUtils
    dxPrinting
    dxProtectionUtils
    dxSVGImage
    dxScreenTip
    dxScrollAnimation
    dxScrollbarAnnotations
    dxShadowWindow
    dxSkinNames
    dxSkinsCore
    dxSkinsStrs
    dxSmartImage
    dxSpellCheckerCore
    dxSplashForms
    dxThemeManager
    dxThreading
    dxTouch
    dxUIAClasses
    TdxAutomationElementSettings
    Members
    Properties
    Methods
    Events
    TdxAutomationProperties
    TdxAutomationProperty
    TdxAutomationProperty<T>
    TdxCalculateAutomationPropertyEvent
    TdxInitializeAutomationPropertiesEvent
    TdxStringAutomationProperty
    TdxUIADefaultSettings
    dxUIACalculateAllProperties
    dxUIAutomationEnabled
    dxUxTheme
    dxX509Certificate
    dxXMLDoc
    ExpressQuantumGrid Suite
    ExpressEditors Library
    ExpressBars Suite
    ExpressCharts Suite
    ExpressDashboards Suite
    ExpressReports Suite
    ExpressRichEditControl Suite
    ExpressSkins Library
    ExpressScheduler Suite
    ExpressSpreadSheet Suite
    ExpressQuantumTreeList Suite
    ExpressPDFViewer Suite
    ExpressPrinting System
    ExpressLayoutControl Suite
    ExpressNavBar Suite
    ExpressPivotGrid Suite
    ExpressVerticalGrid Suite
    ExpressDocking Library
    ExpressMemData
    ExpressDataController
    ExpressSpellChecker Suite
    ExpressMapControl Suite
    ExpressGanttControl Suite
    ExpressGaugeControl Suite
    ExpressTileControl Suite
    ExpressFlowChart Suite
    ExpressFlowChart Editor
    ExpressOrgChart Suite
    ExpressPageControl Suite
    ExpressWizardControl Suite

    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. The TdxAutomationElementSettings class implements settings common to all DevExpress UI controls with support for UI Automation.

    In this topic…

    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:

    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.

    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 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

    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 as external UIA node name and description sources for the current DevExpress control/UI element.

    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 control and content 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 compatible 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.

    Editors

    TcxButtonGroupItem.Automation
    Provides access to the button’s UI Automation and accessibility-related settings.
    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
    TcxRadioButton.Automation
    Provides access to radio button UI Automation and accessibility-related 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.
    TdxNavBarCustomItem.Automation
    Provides access to UI Automation and accessibility-related settings for the navigation bar item.
    TdxNavBarCustomOfficeNavigationBar.Automation

    Miscellaneous Controls

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

    Terminal TdxAutomationElementSettings Class Descendants

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

    TdxGridColumnAutomationSettings
    Stores UI Automation tree-related settings for a grid column.
    TdxGridTableViewAutomationSettings
    Stores UI Automation tree-related settings for a grid Table View.
    TdxTreeListAutomationSettings
    Stores UI Automation tree-related settings for a Tree List control.

    Inheritance

    TObject
    TPersistent
    TInterfacedPersistent
    TcxInterfacedPersistent
    TdxAutomationElementSettings
    See Also