Atributo x:Name

Identifica exclusivamente os elementos de objeto para acesso ao objeto instanciado por code-behind ou código geral. Uma vez aplicado a um modelo de programação de backup, x:Name pode ser considerado equivalente à variável que contém uma referência de objeto, conforme retornado por um construtor.

Uso do atributo XAML

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

Valores XAML

Gramática XamlName

A seguir está a gramática normativa para uma cadeia de caracteres que é usada como uma chave nesta implementação XAML:

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

• Os caracteres são restritos ao intervalo ASCII inferior e, mais especificamente, a letras maiúsculas e minúsculas do alfabeto romano, dígitos e o caractere sublinhado (_).
• Não há suporte para o intervalo de caracteres Unicode.
• Um nome não pode começar com um dígito. Algumas implementações de ferramentas anexam um sublinhado (_) a uma cadeia de caracteres se o usuário fornecer um dígito como o caractere inicial ou a ferramenta gerar automaticamente valores x:Name com base em outros valores que contêm dígitos.

Observações

O x:Name especificado torna-se o nome de um campo que é criado no código subjacente quando XAML é processado e esse campo mantém uma referência ao objeto. O processo de criação desse campo é executado pelas etapas de destino do MSBuild, que também são responsáveis por unir as classes parciais para um arquivo XAML e seu code-behind. Esse comportamento não é necessariamente especificado na linguagem XAML; é a implementação particular da programação da Plataforma Universal do Windows (UWP) para XAML que aplica o uso de x:Name em seus modelos de programação e de aplicativos.

Cada x:Name definido deve ser exclusivo em um namescope XAML. Geralmente, um namescope XAML é definido no nível do elemento raiz de uma página carregada e contém todos os elementos sob esse elemento em uma única página XAML. Namescopes XAML adicionais são definidos por qualquer modelo de controle ou modelo de dados definido nessa página. Em tempo de execução, outro namescope XAML é criado para a raiz da árvore de objetos criada a partir de um modelo de controle aplicado e também por árvores de objeto criadas a partir de uma chamada para XamlReader.Load. Para obter mais informações, consulte namescopes XAML.

As ferramentas de design geralmente geram valores x:Name automaticamente para elementos quando são introduzidos na superfície de design. O esquema de geração automática varia dependendo de qual designer você está usando, mas um esquema típico é gerar uma cadeia de caracteres que começa com o nome da classe que apoia o elemento, seguido por um inteiro avançado. Por exemplo, se você introduzir o primeiro elemento Button ao designer, poderá ver que, no XAML, esse elemento tem o valor do atributo x:Name de "Button1".

X:Name não pode ser definido na sintaxe do elemento de propriedade XAML ou no código usando SetValue. x:Name só pode ser definido usando a sintaxe do atributo XAML nos elementos.

x:Name e outras propriedades de Name

Alguns tipos usados no XAML também têm uma propriedade chamada Name. Por exemplo, FrameworkElement.Name e TextElement.Name.

Se Name estiver disponível como uma propriedade configurável em um elemento, Name e x:Name poderão ser usados de forma intercambiável em XAML, mas um erro resultará se ambos os atributos forem especificados no mesmo elemento. Também há casos em que há uma propriedade Name , mas é somente leitura (como VisualState.Name). Se esse for o caso, você sempre usará x:Name para nomear esse elemento no XAML, e o atributo Nome de somente leitura existe para cenários de código menos comuns.

ObserveFrameworkElement.Name geralmente não deve ser usado como uma maneira de alterar valores originalmente definidos por x:Name, embora haja alguns cenários que são exceções a essa regra geral. Em cenários típicos, a criação e definição de namescopes XAML é uma operação de processador XAML. Modificar FrameworkElement.Name em tempo de execução pode resultar em um namescope XAML inconsistente e no desalinhamento de nomenclatura de campo privado, o que é difícil de controlar em seu código subjacente.

x:Name e x:Key

x:Name pode ser aplicado como um atributo a elementos em um ResourceDictionary para atuar como um substituto para o atributo x:Key. (É uma regra que todos os elementos em um ResourceDictionary devem ter um atributo x:Key ou x:Name.) Isso é comum para animações com storyboard. Para obter mais informações, consulte a seção de ResourceDictionary e referências de recursos XAML.