AutomationElement.NameProperty Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the Name property.

public: static initonly System::Windows::Automation::AutomationProperty ^ NameProperty;

public static readonly System.Windows.Automation.AutomationProperty NameProperty;

 staticval mutable NameProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly NameProperty As AutomationProperty 

Field Value

AutomationProperty

Examples

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;

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.

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

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

Remarks

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.

See also

• UI Automation Properties Overview