AutomationProperties Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Fornece suporte para obter ou definir valores no nível da instância das propriedades de automação. Esses valores de propriedade são definidos como propriedades anexadas (normalmente em XAML) e complementam ou substituem valores de propriedade de automação do AutomationPeer de um controle.
public ref class AutomationProperties sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AutomationProperties final[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AutomationPropertiesPublic NotInheritable Class AutomationProperties- Herança
- Atributos
Requisitos do Windows
| Família de dispositivos |
Windows 10 (introduzida na 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduzida na v1.0)
|
Exemplos
Dica
Abra o aplicativo Galeria do WinUI 3 e veja os seguintes princípios de acessibilidade em ação:
O aplicativo Galeria do WinUI 3 inclui exemplos interativos da maioria dos controles, recursos e funcionalidades do WinUI 3. Obtenha o aplicativo da Microsoft Store ou obtenha o código-fonte no GitHub
Comentários
AutomationProperties é a classe de serviço de host para várias propriedades anexadas XAML. A finalidade dessas propriedades anexadas é habilitar a configuração de vários valores por instância pertinentes à forma como um elemento de interface do usuário é relatado à estrutura de acessibilidade do Microsoft Automação da Interface do Usuário. Isso é útil nos casos em que o design de classe do elemento de interface do usuário ainda não encaminha outros valores de propriedade relacionados à interface do usuário como parte de sua integração do Microsoft Automação da Interface do Usuário ou comportamento de implementação de par ou em que o valor que está sendo encaminhado não é o valor que você deseja relatar ao Microsoft Automação da Interface do Usuário.
Para dar suporte ao acesso do processador XAML às propriedades anexadas e também para expor operações de obtenção e definição equivalentes ao código, cada propriedade anexada XAML tem um par de métodos de acessador Get e Set , que também são membros de AutomationProperties. Por exemplo, os métodos GetName e SetName dão suporte e fornecem o suporte somente de código equivalente para relatar valores name de automação para o Microsoft Automação da Interface do Usuário, em vez de usar a propriedade anexada Name para defini-lo em XAML. Como alternativa, você pode usar o sistema de propriedades de dependência para obter ou definir o valor da propriedade anexada, e isso também relata o valor subjacente para o Microsoft Automação da Interface do Usuário. Chame GetValue ou SetValue, passando os argumentos do identificador de propriedade de dependência para definir e uma referência ao objeto de destino no qual obter ou definir o valor.
Propriedade Name
Das várias propriedades anexadas, provavelmente a mais importante é Nome. Isso ocorre porque é a propriedade Name que é acessada com mais frequência e relatada pela tecnologia adaptativa quando os usuários interagem com um aplicativo em um cenário de acessibilidade. O Nome serve como o identificador legível para o elemento de interface do usuário.
Vários elementos de interface do usuário têm encaminhamento de pares que podem fornecer um valor name padrão com base em outras propriedades de elemento. Por exemplo, o encaminhamento de pares para a classe Button encaminhará a avaliação ToString do conteúdo do Botão e usará essa cadeia de caracteres como o Nome padrão. Para substituir esse padrão ou fornecer um valor Name para qualquer caso de elemento de interface do usuário em que não haja nenhum Nome do Microsoft Automação da Interface do Usuário disponível, defina a propriedade anexada Name nesse elemento em XAML. Para obter mais informações sobre por que um Nome de Automação da Interface do Usuário da Microsoft é importante, consulte Informações básicas de acessibilidade. Para obter mais informações sobre como testar se um elemento já tem um Nome fornecido por pares que é útil, consulte Teste de acessibilidade.
Por motivos de localização, você deve evitar valores de cadeia de caracteres embutidos em código para o Nome em XAML. Se você definir a diretiva x:Uid no elemento , poderá usar recursos RESW para direcionar a propriedade e fornecer valores diferentes para localização. Para propriedades anexadas, o formulário de identificador de recurso requer a qualificação completa da propriedade anexada no formato XAML, incluindo seu namespace e um prefixo using: . Por exemplo, para direcionar o valor da propriedade anexada AutomationProperties.Name em um recurso que tem o valor da diretiva x:Uid de "sendButton", o valor do nome do item de dados nos recursos RESW é sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name
Consulte Propriedades anexadas para obter uma lista completa (para obter mais informações sobre cada propriedade anexada, consulte o campo Identificador de cada propriedade).
Histórico de versão
| Versão do Windows | Versão do SDK | Valor adicionado |
|---|---|---|
| 1511 | 10586 | GetLandmarkType |
| 1511 | 10586 | GetLocalizedLandmarkType |
| 1511 | 10586 | SetLandmarkType |
| 1511 | 10586 | SetLocalizedLandmarkType |
| 1607 | 14393 | GetDescribedBy |
| 1607 | 14393 | GetFlowsFrom |
| 1607 | 14393 | GetFlowsTo |
| 1607 | 14393 | GetFullDescription |
| 1607 | 14393 | GetIsDataValidForForm |
| 1607 | 14393 | GetIsPeripheral |
| 1607 | 14393 | GetLocalizedControlType |
| 1607 | 14393 | SetFullDescription |
| 1607 | 14393 | SetIsDataValidForForm |
| 1607 | 14393 | SetIsPeripheral |
| 1607 | 14393 | SetLocalizedControlType |
| 1703 | 15063 | GetCulture |
| 1703 | 15063 | SetCulture |
| 1803 | 17134 | GetHeadingLevel |
| 1803 | 17134 | SetHeadingLevel |
| 1809 | 17763 | GetIsDialog |
| 1809 | 17763 | SetIsDialog |
Propriedades
Propriedades Anexadas
| AcceleratorKey |
Obtém ou define uma cadeia de caracteres que contém as combinações de tecla de acelerador (também chamada de tecla de atalho) para o elemento de automação. |
| AccessibilityView |
Obtém ou define o modo de exibição de árvore do Microsoft Automação da Interface do Usuário para um elemento . |
| AccessKey |
Obtém ou define uma cadeia de caracteres que contém o caractere de chave de acesso para o elemento de automação. |
| Annotations |
Obtém uma lista de objetos de anotação em um documento, como comentário, cabeçalho, rodapé e assim por diante. |
| AutomationControlType |
Obtém ou define o tipo de controle do Microsoft Automação da Interface do Usuário. |
| AutomationId |
Obtém ou define a cadeia de caracteres que identifica exclusivamente o elemento como Microsoft Automação da Interface do Usuário. |
| ControlledPeers |
Obtém uma coleção de elementos de automação que podem ser manipulados pelo elemento de automação especificado. |
| Culture |
Obtém ou define o identificador de localidade para o elemento de automação (por exemplo, 0x0409 para "en-US" ou inglês (Estados Unidos)). |
| DescribedBy |
Obtém uma matriz de elementos que fornecem mais informações sobre o elemento de automação. |
| FlowsFrom |
Obtém uma matriz de elementos de automação que sugere a ordem de leitura antes do elemento de automação atual. |
| FlowsTo |
Obtém uma matriz de elementos de automação que sugere a ordem de leitura após o elemento de automação atual. |
| FullDescription |
Obtém ou define uma cadeia de caracteres localizada que contém texto de descrição estendido para um elemento. |
| HeadingLevel |
Obtém ou define o nível de título de um elemento Automação da Interface do Usuário. |
| HelpText |
Obtém ou define uma cadeia de caracteres de texto de ajuda associada ao elemento de automação. |
| IsDataValidForForm |
Obtém ou define um valor que indica se os dados são válidos para o formulário. |
| IsDialog |
Obtém ou define um valor que indica se o elemento de automação é uma janela de diálogo. |
| IsPeripheral |
Obtém ou define um valor que indica se o elemento de automação representa a interface do usuário periférica. |
| IsRequiredForForm |
Obtém ou define um valor que indica se o elemento deve ser preenchido em um formulário. |
| ItemStatus |
Obtém ou define uma descrição do status de um item em um elemento . |
| ItemType |
Obtém ou define uma descrição do tipo de elemento especificado. |
| LabeledBy |
Obtém ou define o elemento de automação que contém o rótulo de texto para esse elemento. |
| LandmarkType |
Obtém ou define um Identificador de Tipo de Ponto de Referência associado a um elemento. |
| Level |
Obtém ou define um inteiro baseado em 1 que descreve o local de um elemento dentro de estruturas hierárquicas hierárquicas ou quebradas. |
| LiveSetting |
Obtém ou define o valor de configuração dinâmica para o elemento especificado, que tem suporte de um elemento de automação que representa uma região dinâmica. |
| LocalizedControlType |
Obtém ou define uma cadeia de caracteres de texto localizada que descreve o tipo de controle que o elemento de automação representa. |
| LocalizedLandmarkType |
Obtém ou define uma cadeia de caracteres de texto localizada que descreve o tipo de ponto de referência que o elemento de automação representa. |
| Name |
Obtém ou define o nome Automação da Interface do Usuário do elemento. |
| PositionInSet |
Obtém ou define um inteiro baseado em 1 que descreve o local ordinal do elemento dentro de um conjunto de elementos que são considerados irmãos. |
| SizeOfSet |
Obtém ou define o número de elementos em um conjunto de elementos que são considerados irmãos. |
Métodos
| GetAcceleratorKey(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.AcceleratorKey para o DependencyObject especificado. |
| GetAccessibilityView(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.AccessibilityView para o DependencyObject especificado. |
| GetAccessKey(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.AccessKey para o DependencyObject especificado. |
| GetAnnotations(DependencyObject) |
Obtém o valor da propriedade AutomationProperties.Annotations para o DependencyObject especificado. |
| GetAutomationControlType(UIElement) |
Obtém o valor da propriedade anexada AutomationProperties.AutomationControlType para o DependencyObject especificado. |
| GetAutomationId(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.AutomationId para o DependencyObject especificado. |
| GetControlledPeers(DependencyObject) |
Um método de utilitário estático que recupera a lista de pares controlados de um proprietário de destino. |
| GetCulture(DependencyObject) |
Obtém o valor da propriedade anexada Culture XAML para o DependencyObject especificado. |
| GetDescribedBy(DependencyObject) |
Obtém uma coleção de elementos que fornecem mais informações sobre o elemento de automação especificado. |
| GetFlowsFrom(DependencyObject) |
Obtém uma lista de elementos de automação que sugere a ordem de leitura antes do elemento de automação especificado. |
| GetFlowsTo(DependencyObject) |
Obtém uma lista de elementos de automação que sugere a ordem de leitura após o elemento de automação especificado. |
| GetFullDescription(DependencyObject) |
Obtém o valor da propriedade AutomationProperties.FullDescription para o DependencyObject especificado. |
| GetHeadingLevel(DependencyObject) |
Obtém o valor da propriedade AutomationProperties.HeadingLevel para o DependencyObject especificado. |
| GetHelpText(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.HelpText para o DependencyObject especificado. |
| GetIsDataValidForForm(DependencyObject) |
Obtém o valor da propriedade AutomationProperties.IsDataValidForForm para o DependencyObject especificado. |
| GetIsDialog(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.IsDialog para o DependencyObject especificado. |
| GetIsPeripheral(DependencyObject) |
Obtém um valor booliano que indica se o elemento especificado representa a interface do usuário periférica. |
| GetIsRequiredForForm(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.IsRequiredForForm para o DependencyObject especificado. |
| GetItemStatus(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.ItemStatus para o DependencyObject especificado. |
| GetItemType(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.ItemType para o DependencyObject especificado. |
| GetLabeledBy(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.LabeledBy para o DependencyObject especificado. |
| GetLandmarkType(DependencyObject) |
Obtém o valor da propriedade anexada do tipo de ponto de referência para o DependencyObject especificado. |
| GetLevel(DependencyObject) |
Obtém o valor da propriedade AutomationProperties.Level para o elemento especificado. |
| GetLiveSetting(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.LiveSetting para o DependencyObject especificado. |
| GetLocalizedControlType(DependencyObject) |
Obtém uma cadeia de caracteres localizada que indica o tipo do controle especificado. |
| GetLocalizedLandmarkType(DependencyObject) |
Obtém o valor da propriedade anexada do tipo de ponto de referência localizado para o DependencyObject especificado. |
| GetName(DependencyObject) |
Obtém o valor da propriedade anexada AutomationProperties.Name para o DependencyObject especificado. |
| GetPositionInSet(DependencyObject) |
Obtém o valor da propriedade AutomationProperties.PositionInSet para o DependencyObject especificado. |
| GetSizeOfSet(DependencyObject) |
Obtém o valor da propriedade AutomationProperties.SizeOfSet para o DependencyObject especificado. |
| SetAcceleratorKey(DependencyObject, String) |
Define o valor da propriedade anexada AutomationProperties.AcceleratorKey para o DependencyObject especificado. |
| SetAccessibilityView(DependencyObject, AccessibilityView) |
Define o valor da propriedade anexada AutomationProperties.AccessibilityView para o DependencyObject especificado. |
| SetAccessKey(DependencyObject, String) |
Define o valor da propriedade anexada AutomationProperties.AccessKey para o DependencyObject especificado. |
| SetAutomationControlType(UIElement, AutomationControlType) |
Define o valor da propriedade anexada AutomationProperties.AutomationControlType para o DependencyObject especificado. |
| SetAutomationId(DependencyObject, String) |
Define o valor da propriedade anexada AutomationProperties.AutomationId para o DependencyObject especificado. |
| SetCulture(DependencyObject, Int32) |
Define o valor da propriedade anexada Culture para o DependencyObject especificado. |
| SetFullDescription(DependencyObject, String) |
Define uma cadeia de caracteres localizada que descreve a aparência visual ou o conteúdo do DependencyObject especificado. |
| SetHeadingLevel(DependencyObject, AutomationHeadingLevel) |
Define o valor da propriedade AutomationProperties.HeadingLevel para o DependencyObject especificado. |
| SetHelpText(DependencyObject, String) |
Define o valor da propriedade anexada AutomationProperties.HelpText para o DependencyObject especificado. |
| SetIsDataValidForForm(DependencyObject, Boolean) |
Define um valor booliano que indica se o valor inserido ou selecionado é válido para a regra de formulário associada ao elemento especificado. |
| SetIsDialog(DependencyObject, Boolean) |
Define um valor booliano que indica se o elemento especificado deve ser identificado como uma janela de diálogo. |
| SetIsPeripheral(DependencyObject, Boolean) |
Define um valor booliano que indica se o elemento especificado representa a interface do usuário periférica. |
| SetIsRequiredForForm(DependencyObject, Boolean) |
Define o valor da propriedade anexada AutomationProperties.IsRequiredForForm para o DependencyObject especificado. |
| SetItemStatus(DependencyObject, String) |
Define o valor da propriedade anexada AutomationProperties.ItemStatus para o DependencyObject especificado. |
| SetItemType(DependencyObject, String) |
Define o valor da propriedade anexada AutomationProperties.ItemType para o DependencyObject especificado. |
| SetLabeledBy(DependencyObject, UIElement) |
Define o valor da propriedade anexada AutomationProperties.LabeledBy para o DependencyObject especificado. |
| SetLandmarkType(DependencyObject, AutomationLandmarkType) |
Define o valor da propriedade anexada do tipo de ponto de referência para o DependencyObject especificado. |
| SetLevel(DependencyObject, Int32) |
Define o valor da propriedade anexada AutomationProperties.Level para o DependencyObject especificado. |
| SetLiveSetting(DependencyObject, AutomationLiveSetting) |
Define o valor da propriedade anexada AutomationProperties.LiveSetting para o DependencyObject especificado. |
| SetLocalizedControlType(DependencyObject, String) |
Define uma cadeia de caracteres localizada que indica o tipo do controle especificado. |
| SetLocalizedLandmarkType(DependencyObject, String) |
Define o valor da propriedade anexada do tipo de ponto de referência localizado para o DependencyObject especificado. |
| SetName(DependencyObject, String) |
Define o valor do AutomationProperties.Name propriedade anexada para o DependencyObject especificado. |
| SetPositionInSet(DependencyObject, Int32) |
Define o valor da propriedade anexada AutomationProperties.PositionInSet para o DependencyObject especificado. |
| SetSizeOfSet(DependencyObject, Int32) |
Define o valor da propriedade anexada AutomationProperties.SizeOfSet para o DependencyObject especificado. |