Back to Devexpress

TdxAutomationElementSettings.Name Property

vcl-dxuiaclasses-dot-tdxautomationelementsettings.md

latest3.0 KB
Original Source

TdxAutomationElementSettings.Name Property

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

Declaration

delphi
property Name: string read; write;

Property Value

TypeDescription
string

The control/UI element name in the UI Automation tree.

|

Remarks

A control’s Caption serves as the default name for the corresponding node in the UI Automation tree. You can use the Name property to specify a different name for the UIA node associated with the control and retain the current caption in the UI.

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.

Corresponding UIA Framework Field

The Name property corresponds to the NameProperty field.

Default Value

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

The default Name property value indicates that the control/UI element uses its Caption as the corresponding UIA node name.

See Also

TdxAutomationProperties.Name Property

TdxAutomationElementSettings Class

TdxAutomationElementSettings Members

dxUIAClasses Unit