TdxAutomationElementSettings.Description Property

Specifies the control/UI element description in the UI Automation tree.

Declaration

property Description: string read; write;

Property Value

Type	Description
string	The optional UI element description.

Remarks

A control’s Hint serves as the default description for the corresponding node in the UI Automation tree. A UIA node description is designed to store optional information on the corresponding control/UI element.

You can use the Description property to define a different description for the UIA node associated with the control and retain the current hint (if defined).

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 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 controls use different value sources.

Default Value

The Description property’s default value is an empty string.

The default Description property value indicates that the control/UI element uses its Hint as the corresponding UIA node description. If no hint is assigned, the UIA node has no description.