AutomationPeer.GetName 方法

定义

命名空间:

Windows.UI.Xaml.Automation.Peers

获取描述与此自动化同级关联的元素的文本。 Microsoft UI 自动化 名称 值是大多数辅助技术通过与 Microsoft UI 自动化框架交互来表示应用的 UI 时使用的主要标识符。

public:
 virtual Platform::String ^ GetName() = GetName;

winrt::hstring GetName();

public string GetName();

function getName()

Public Function GetName () As String

返回

String

Platform::String

winrt::hstring

作为对等方所有者的元素的名称，由辅助技术和其他 Microsoft UI 自动化客户端使用。

注解

FrameworkElementAutomationPeer 通过提供中间 GetNameCore 实现来引入 GetName 的行为。 如果元素具有 LabeledByMicrosoft UI 自动化属性的值，则标记元素的 Name 值将用作 Name。

FrameworkElementAutomationPeer 还通过内部 GetPlainText 方法引入行为，其他默认对等类可能会重写这些行为，以便访问该控件的内容模型，并为 Name 返回有用的默认值。 例如，任何 ContentControl 派生类都将使用其 Content 值的字符串表示形式作为默认 名称。 启用此功能是因为 ContentControl 在内部实现 GetPlainText 并将该行为分配给所有 ContentControl 派生类。 例如，这是从 Button 的字符串值获取有用的名称默认值的方式。

其他特定对等方可能还具有中间 GetNameCore 实现，该实现为该特定Windows 运行时控件提供了一种有用的方法来为 Name 提供内置值。 这些值的源来自通常在 XAML 中或作为应用用户代码设置的其他 UI 属性。 例如，TextBoxAutomationPeer 实现的行为，该行为使用所有者 TextBox 中的 Text 属性值作为默认名称。 从用户代码的角度来看，可以通过应用不同的 AutomationProperties.Name 值来替代默认行为。 从对等实现者/提供程序的角度来看，可以通过从现有对等方派生一个新的对等类、替代 GetNameCore 并为其提供一个新的实现来更改对等的默认行为，该实现至少在某些情况下不会调用基实现。

若要详细了解默认Windows 运行时控件的特定对等类可能的默认行为，请参阅该特定对等类的参考主题，并在“备注”部分中查找实现说明。

另请参阅

• 自定义的自动化对等