AutomationElement.AcceleratorKeyProperty Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the AcceleratorKey property.

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

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

 staticval mutable AcceleratorKeyProperty : System.Windows.Automation.AutomationProperty

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

Dim acceleratorKey As String = _
    CStr(autoElement.GetCurrentPropertyValue(AutomationElement.AcceleratorKeyProperty))

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

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

Accelerator key combinations invoke an action. For example, CTRL+O is often used to invoke the Open file common dialog box. An AutomationElement that has the accelerator key property set always implements the InvokePattern class.

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