AutomationElement.NameProperty Field

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Identifies the Name property.

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

public static readonly AutomationProperty 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.

string nameProp =
    autoElement.GetCurrentPropertyValue(AutomationElement.NameProperty) as string;

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.

string nameProp1;
object namePropNoDefault =
    autoElement.GetCurrentPropertyValue(AutomationElement.NameProperty, true);
if (namePropNoDefault == AutomationElement.NotSupported)
{
    nameProp1 = "No name.";
}
else
{
    nameProp1 = namePropNoDefault as string;
}

.NET Framework
Available since 3.0
Return to top
Show: