AutomationPeer.GetName Method

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Gets the value that the automation peer reports as the UI Automation Name for the associated control.

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

Syntax

Public Function GetName As String
public string GetName()

Return Value

Type: System..::.String
The value to report as the UI Automation Name.

Remarks

Peers that affect the GetName value by overriding GetNameCore are generally implementing a behavior that can construct a usable UI Automation Name on basis of other property values of the associated control. For example, GetNameCore()()() implements a behavior that can process the button content by calling ToString on the content, and then returns the string so long as it is not empty or null. This enables a button composition such as <Button>OK</Button> to report its default UI Automation Name as "OK", without requiring any other usercode such as specifying AutomationProperties..::.Name.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

AutomationPeer Class

System.Windows.Automation.Peers Namespace