x:Name 属性

项目
07/14/2023

唯一标识对象元素，可方便从代码隐藏或一般代码中访问已实例化的对象。应用于支持的编程模型之后，x:Name 可视为等效于持有一个对象引用（由一个构造函数返回）的变量。

XAML 属性使用方法

<object x:Name="XAMLNameValue".../>

XAML 值

术语	说明
XAMLNameValue	一个符合 XamlName 语法限制的字符串。

XamlName 语法

以下是在此 XAML 实现中作为密钥使用的字符串的规范语法：

XamlName ::= NameStartChar (NameChar)*
NameStartChar ::= LetterCharacter | '_'
NameChar ::= NameStartChar | DecimalDigit
LetterCharacter ::= ('a'-'z') | ('A'-'Z')
DecimalDigit ::= '0'-'9'
CombiningCharacter::= none

字符被限制在较低的 ASCII 范围，具体而言，就是大写和小写罗马字母、数字和下划线 (_) 字符。
不支持 Unicode 字符范围。
名称不能以数字开头。某些工具实现会在用户以数字作为起始字符时在字符串前附加一个下划线 (_)，工具也可以根据包含数字的其他值自动生成 x:Name 值。

注解

当处理 XAML 时，指定的 x:Name 变成一个在基础代码中创建的字段的名称，该字段持有该对象的引用。创建此字段的过程由 MSBuild 目标步骤执行，这些步骤还负责连接一个 XAML 文件和它的代码隐藏的分部类。此行为不一定是由 XAML 语言指定的，它是通用 Windows 平台 (UWP) XAML 编程的特定实现，应用在其编程和应用程序模型中使用 x:Name。

每个已定义的 x:Name 在一个 XAML 名称范围中必须是唯一的。通常，XAML 名称范围在所加载页面的根元素级别定义，其中包含单个 XAML 页面中该元素下面的所有元素。其他 XAML 名称范围由在该页面上定义的任何控件模板或数据模板定义。在运行时，其他 XAML 名称范围是为从所应用的控件模板创建的对象树的根，以及由从 XamlReader.Load 调用创建的对象树定义的。有关详细信息，请参阅 XAML 空间范围。

在将元素引入设计界面时，设计工具常常会自动为它们生成 x:Name 值。该自动生成架构因使用的设计器不同而不同，但一种典型的架构是生成一个字符串，它以支持该元素的类名开头，后跟一个延长的整数。例如，如果向设计器引入第一个 Button 元素，则可以在 XAML 中看到，此元素拥有 x:Name 属性值“Button1”。

无法在 XAML 属性元素语法中或在代码中使用 SetValue 设置 x:Name。只能在元素上使用 XAML 属性语法来设置 x:Name。

注意x:Name 引用的支持字段是专为 C++/CX 应用创建的，而不是为 XAML 文件或页面的根元素创建的。如果你需要从 C++ 代码隐藏来引用根对象，请使用其他 API 或树形遍历。例如，你可以为已知的命名子元素调用 FindName，然后调用 Parent。

x:Name 和其他 Name 属性

UWP XAML 中使用的一些类型还具有一个名为 Name 的属性。例如，FrameworkElement.Name 和 TextElement.Name。

如果 Name 可用作一个元素上的可设置属性，Name 和 x:Name 可在 XAML 中交替使用，但如果在相同元素上指定了这两个属性，会发生错误。有时，会存在一个只读的 Name 属性（如 VisualState.Name）。如果出现这种情况，请在 XAML 中始终使用 x:Name 对该元素进行命名，而且对于一些少见的代码方案使用只读的 Name。

注意FrameworkElement.Name 通常不应当用于更改最初由 x:Name 设置的值，但这个一般规则有一些例外的场景。在典型的场景中，XAML 名称范围的创建和定义是一个 XAML 处理器操作。在运行时修改 FrameworkElement.Name 可能会导致不一致的 XAML 名称范围/专用字段命名对齐，这种不一致在代码隐藏文件中很难跟踪。

x:Name 和 x:Key

x:Name 可以作为一个属性应用到 ResourceDictionary 内的元素，以充当 x:Key 属性的替代属性。（通常，要求 ResourceDictionary 中的所有元素都必须具有一个 x:Key 或 x:Name 属性。）这常见于情节提要动画。有关详细信息，请参阅 ResourceDictionary 和 XAML 资源引用部分。