AutomationPeer.GetAutomationId Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets the AutomationId of the object that is associated with the automation peer.

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

Syntax

'Declaration
Public Function GetAutomationId As String
public string GetAutomationId()

Return Value

Type: System.String
The automation identifier.

Remarks

This implementation does nothing more than calling GetAutomationIdCore.

In general, a UI Automation AutomationID is more relevant to automation scenarios, whereas a UI Automation Name is more relevant to accessibility scenarios.

In practical terms, the value of the UI Automation identifier is generally the AutomationId property. If that property is not set, the value is the Name property. However that behavior is not yet implemented at this level. See FrameworkElementAutomationPeer.GetAutomationIdCore.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.