Skip to main content
All docs
V25.2
  • TdxTreeListAutomationSettings Class

    Stores UI Automation tree-related settings for a Tree List control.

    Declaration

    TdxTreeListAutomationSettings = 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.

    Main API Members

    The list below outlines key members of the TdxTreeListAutomationSettings class. These members configure tree list content mapping to nodes in a UI Automation tree if the dxUIAutomationEnabled global variable is set to True.

    DefaultIncludeCellsInRowName
    Specifies if all visible column values are included in the UI Automation node that corresponds to the focused row. For example, this option can be useful if the Tree List control contains no more than four or five visible columns.
    DescribedBy | NamedBy

    Specify controls used as sources of the current Tree List control 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 Tree List control in the UI Automation tree. Third-party UIA clients read these properties when the Tree List control accepts focus.
    IsContentElement | IsControlElement
    Specify if the Tree List control belongs to content and control views (subsets) of the UI Automation tree.

    UI Automation Events

    OnCalculateProperty
    Allows you to modify calculated UIA property values for the current Tree List depending on certain conditions.
    OnCalculateRowProperty
    Allows you to modify calculated UIA node property values for an individual row in the Tree List control.
    OnInitializeProperties
    Allows you to initialize individual UIA node properties manually for the current Tree List control.
    OnInitializeRowProperties
    Allows you to initialize individual UIA properties manually for an individual row in the current Tree List control.

    General-Purpose API Members

    Assign | AssignTo
    Copy UI Automation tree settings between Tree List controls.

    Direct TdxTreeListAutomationSettings Class Reference

    The TcxCustomTreeList.Automation property references a TdxTreeListAutomationSettings object.

    See Also