Export (0) Print
Expand All
Expand Minimize

AutomationElement.AccessKeyProperty Field

Identifies the AccessKey property.

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

'Declaration
Public Shared ReadOnly AccessKeyProperty As AutomationProperty

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.

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


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.


        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



.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft