AutomationElement.ClassNameProperty Field

Reference

Definition

Namespace:: System.Windows.Automation

Assembly:: UIAutomationClient.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Identifies the ClassName property.

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

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

 staticval mutable ClassNameProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly ClassNameProperty 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 className =
    autoElement.GetCurrentPropertyValue(AutomationElement.ClassNameProperty) as string;

Dim className As Object = autoElement.GetCurrentPropertyValue(AutomationElement.ClassNameProperty)

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 classNameString;
object classNameNoDefault =
    autoElement.GetCurrentPropertyValue(AutomationElement.ClassNameProperty, true);
if (classNameNoDefault == AutomationElement.NotSupported)
{
    // TODO Handle the case where you do not wish to proceed using the default value.
}
else
{
    classNameString = classNameNoDefault as string;
}

Dim classNameString As String
Dim classNameNoDefault As Object = autoElement.GetCurrentPropertyValue(AutomationElement.ClassNameProperty, True)
If classNameNoDefault Is AutomationElement.NotSupported Then
    ' TODO Handle the case where you do not wish to proceed using the default value.
Else
    classNameString = CStr(classNameNoDefault)
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.

The class name depends on the implementation of the UI Automation provider and therefore cannot be counted upon to be in a standard format. However, if you know the class name you can use it to verify that your application is working with the expected UI Automation element.

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

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via