This documentation is archived and is not being maintained.

AutomationElement.NameProperty Field

Identifies the Name property.

Namespace:  System.Windows.Automation
Assembly:  UIAutomationClient (in UIAutomationClient.dll)

'Declaration
Public Shared ReadOnly NameProperty As AutomationProperty
'Usage
Dim value As AutomationProperty 

value = AutomationElement.NameProperty

This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent identifier in AutomationElementIdentifiers.

This property can also be retrieved from the Current or Cached properties.

Return values of the property are of type String. The default value for the property is an empty string.

The following example retrieves the current value of the property. The default value is returned if the element does not provide one.

Dim nameProp As String = _
    CStr(autoElement.GetCurrentPropertyValue(AutomationElement.NameProperty))

The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, NotSupported is to be returned instead of a default value.

Dim nameProp1 As String 
Dim namePropNoDefault As Object = autoElement.GetCurrentPropertyValue(AutomationElement.NameProperty, True)
If namePropNoDefault Is AutomationElement.NotSupported Then
    nameProp1 = "No name." 
Else
    nameProp1 = CStr(namePropNoDefault)
End If

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Show: