AutomationProperties.Name 附加属性

定义

获取或设置元素UI 自动化名称。

see GetName, and SetName
see GetName, and SetName
see GetName, and SetName

注解

属性 Name 应与屏幕上的标签文本相同。 例如, Name 对于标签为“Browse”的按钮元素,应为“浏览”。 属性 Name 不得包含访问键的助记键字符, (“&”) ,该字符在 UI 文本演示文稿中带有下划线。 此外,属性 Name 不应是屏幕标签的扩展版或修改版本,因为名称和标签之间的不一致可能会导致客户端应用程序和用户混淆。

当相应的标签文本在屏幕上不可见时,或者当它被图形替换时,应选择替代文本。 替代文本应简洁直观,并本地化为应用程序 UI 语言或操作系统默认 UI 语言。 替代文本不应是视觉细节的详细说明,而应是 UI 函数或功能的简洁说明,就像用简单文本标记一样。 例如,Windows“开始”菜单按钮名为“开始” (按钮) ,而不是“蓝色圆形图形上的 Windows 徽标” (按钮) 。 有关详细信息,请参阅 为图像创建文本等效项

例如,当 UI 标签使用文本图形 (使用“”>>作为从左到右添加项) 的按钮时, Name 属性应被相应的文本替代 (例如“添加”) 。 但是,由于本地化和辅助功能方面的考虑,不建议使用文本图形作为 UI 标签的做法。

属性 Name 不得包含控件角色或类型信息,如“按钮”或“列表”;否则,当将这两个属性追加 (许多现有辅助技术) 执行此操作时,它将与 LocalizedControlType 属性中的文本冲突。

属性 Name 不能用作同级之间的唯一标识符。 但是,只要它与 UI 呈现一致,对等方就可以支持相同的 Name 值。 对于测试自动化,客户端应考虑使用 AutomationIdRuntimeId 属性。

只要文本模式也受支持,文本控件不必始终使 Name 属性与控件中显示的 文本 相同。

在各种附加属性中,最重要的属性 Name可能是 。 这是因为当用户在 Name 辅助功能方案中与应用交互时,辅助技术最常访问和报告该属性。 Name充当 UI 元素的可读标识符。

各种 UI 元素具有可基于其他元素属性提供默认值 Name 的对等转发。 例如, Button 类的对等转发将转发 ToStringButton 内容的计算,并使用此字符串作为默认 Name。 若要替代该默认值,或者要为没有可用 Microsoft UI 自动化Name的任何 UI 元素提供Name值,Name请在 XAML 中设置该元素的附加属性。 有关 Microsoft UI 自动化Name为何重要的详细信息,请参阅基本辅助功能信息。 有关如何测试元素是否已具有对等提供的 Name 有用内容的详细信息,请参阅 辅助功能测试

出于本地化原因,应避免在 XAML 中为 Name 硬编码字符串值。 如果在 元素上设置 x:Uid 指令 ,则可以使用 RESW 资源以属性为目标,并为本地化提供不同的值。 对于附加属性,资源标识符表单要求以 XAML 形式对附加属性进行完全限定,包括其命名空间和 using: 前缀。 例如,若要将 AutomationProperties.Namex:Uid 指令 值为“sendButton”的资源上的附加属性值, Name RESW 资源 中的数据项的 值为 sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name

适用于

另请参阅