AutomationElement.AccessKeyProperty Field

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

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

 staticval mutable AccessKeyProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly AccessKeyProperty As AutomationProperty 

Field Value

Examples

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

string accessKey =
    autoElement.GetCurrentPropertyValue(AutomationElement.AccessKeyProperty) as string;

Dim accessKey As String = _
    CStr(autoElement.GetCurrentPropertyValue(AutomationElement.AccessKeyProperty))

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

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

An access key is a character in the text of a menu, menu item, or label of a control such as a button that activates the attached menu function. For example, the letter "O" is often used to invoke the File Open common dialog box from a File menu.

Access key values are of type String and contain the character registered as the access key for the element. The default value for the string is an empty string.

Applies to

See also

• UI Automation Properties Overview