AutomationProperties Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Proporciona compatibilidad para obtener o establecer valores de nivel de instancia de propiedades de automatización. Estos valores de propiedad se establecen como propiedades adjuntas (normalmente en XAML) y complementan o invalidan los valores de propiedad de automatización de AutomationPeer de un control.
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- Herencia
- Atributos
Requisitos de Windows
| Familia de dispositivos |
Windows 10 (se introdujo en la versión 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)
|
Ejemplos
Sugerencia
Abra la aplicación WinUI 3 Gallery y vea los siguientes principios de accesibilidad en acción:
La aplicación WinUI 3 Gallery incluye ejemplos interactivos de la mayoría de los controles, características y funcionalidad de WinUI 3. Obtener la aplicación de Microsoft Store o obtener el código fuente en GitHub
Comentarios
AutomationProperties es la clase de servicio host para varias propiedades adjuntas XAML. El propósito de estas propiedades adjuntas es habilitar la configuración de varios valores por instancia que son pertinentes para la forma en que se notifica un elemento de interfaz de usuario al marco de accesibilidad de Microsoft Automatización de la interfaz de usuario. Esto es útil en los casos en los que el diseño de clase del elemento de interfaz de usuario aún no reenvía otros valores de propiedad relacionados con la interfaz de usuario como parte de su comportamiento de integración de Microsoft Automatización de la interfaz de usuario o implementación del mismo nivel, o donde el valor que se reenvía no es el valor que desea informar a Microsoft Automatización de la interfaz de usuario .
Para admitir el acceso del procesador XAML a las propiedades adjuntas, y también para exponer operaciones de obtención y establecimiento equivalentes en el código, cada propiedad adjunta XAML tiene un par de métodos de descriptor de acceso Get y Set , que también son miembros de AutomationProperties. Por ejemplo, los métodos GetName y SetName admiten y proporcionan la compatibilidad equivalente de solo código para informar de los valores name de automatización a Microsoft Automatización de la interfaz de usuario, en lugar de usar la propiedad adjunta Name para establecerla en XAML. Como alternativa, puede usar el sistema de propiedades de dependencia para obtener o establecer el valor de la propiedad adjunta, y esto también informa del valor subyacente a Microsoft Automatización de la interfaz de usuario. Llame a GetValue o SetValue, pasando los argumentos del identificador de propiedad de dependencia que se va a establecer y una referencia al objeto de destino en el que se va a obtener o establecer el valor.
Name (propiedad)
De las distintas propiedades adjuntas, probablemente la más importante sea Name. Esto se debe a que es la propiedad Name a la que se accede con más frecuencia y se notifica mediante la tecnología de asistencia cuando los usuarios interactúan con una aplicación en un escenario de accesibilidad. El nombre actúa como identificador legible para el elemento de la interfaz de usuario.
Varios elementos de la interfaz de usuario tienen reenvío del mismo nivel que puede proporcionar un valor De nombre predeterminado basado en otras propiedades de elemento. Por ejemplo, el reenvío del mismo nivel para la clase Button reenviará la evaluación ToString del contenido de Button y usará esta cadena como nombre predeterminado. Para invalidar ese valor predeterminado, o para proporcionar un valor name para cualquier caso de elemento de interfaz de usuario en el que no haya ningún nombre de Microsoft Automatización de la interfaz de usuario disponible, establezca la propiedad adjunta Name en ese elemento en XAML. Para obtener más información sobre por qué un nombre de Microsoft Automatización de la interfaz de usuario es importante, consulte Información de accesibilidad básica. Para obtener más información sobre cómo probar si un elemento ya tiene un nombre proporcionado por el mismo nivel que resulta útil, consulta Pruebas de accesibilidad.
Por motivos de localización, debes evitar valores de cadena codificados de forma rígida para el nombre en XAML. Si establece la directiva x:Uid en el elemento, puede usar recursos RESW para dirigirse a la propiedad y proporcionar valores diferentes para la localización. Para las propiedades adjuntas, el formulario de identificador de recursos requiere una calificación completa de la propiedad adjunta en formato XAML, incluido su espacio de nombres y un valor using: prefijo. Por ejemplo, para tener como destino el valor de la propiedad adjunta AutomationProperties.Name en un recurso que tiene el valor de directiva x:Uid de "sendButton", el valor de nombre del elemento de datos en los recursos de RESW es sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name
Consulta Propiedades adjuntas para obtener una lista completa (para obtener más información sobre cada propiedad adjunta, consulta el campo Identificador de cada propiedad).
Historial de versiones
| Versión de Windows | Versión del SDK | Valor agregado |
|---|---|---|
| 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 |
Propiedades
Propiedades adjuntas
| AcceleratorKey |
Obtiene o establece una cadena que contiene las combinaciones de teclas de aceleración (también denominada tecla de método abreviado) para el elemento de automatización. |
| AccessibilityView |
Obtiene o establece el modo de vista de árbol de Microsoft Automatización de la interfaz de usuario para un elemento. |
| AccessKey |
Obtiene o establece una cadena que contiene el carácter de clave de acceso para el elemento de automatización. |
| Annotations |
Obtiene una lista de objetos de anotación en un documento, como comentario, encabezado, pie de página, etc. |
| AutomationControlType |
Obtiene o establece el tipo de control para Microsoft Automatización de la interfaz de usuario. |
| AutomationId |
Obtiene o establece la cadena que identifica de forma única el elemento a Microsoft Automatización de la interfaz de usuario. |
| ControlledPeers |
Obtiene una colección de elementos de automatización que el elemento de automatización especificado puede manipular. |
| Culture |
Obtiene o establece el identificador de configuración regional del elemento de automatización (por ejemplo, 0x0409 para "en-US" o inglés (Estados Unidos)). |
| DescribedBy |
Obtiene una matriz de elementos que proporcionan más información sobre el elemento de automatización. |
| FlowsFrom |
Obtiene una matriz de elementos de automatización que sugiere el orden de lectura antes del elemento de automatización actual. |
| FlowsTo |
Obtiene una matriz de elementos de automatización que sugiere el orden de lectura después del elemento de automatización actual. |
| FullDescription |
Obtiene o establece una cadena localizada que contiene texto de descripción extendido para un elemento. |
| HeadingLevel |
Obtiene o establece el nivel de título de un elemento Automatización de la interfaz de usuario. |
| HelpText |
Obtiene o establece una cadena de texto de ayuda asociada al elemento de automatización. |
| IsDataValidForForm |
Obtiene o establece un valor que indica si los datos son válidos para el formulario. |
| IsDialog |
Obtiene o establece un valor que indica si el elemento de automatización es una ventana de diálogo. |
| IsPeripheral |
Obtiene o establece un valor que indica si el elemento de automatización representa la interfaz de usuario periférica. |
| IsRequiredForForm |
Obtiene o establece un valor que indica si es necesario rellenar el elemento en un formulario. |
| ItemStatus |
Obtiene o establece una descripción del estado de un elemento en un elemento. |
| ItemType |
Obtiene o establece una descripción del tipo del elemento especificado. |
| LabeledBy |
Obtiene o establece el elemento de automatización que contiene la etiqueta de texto de este elemento. |
| LandmarkType |
Obtiene o establece un identificador de tipo de punto de referencia asociado a un elemento . |
| Level |
Obtiene o establece un entero basado en 1 que describe la ubicación de un elemento dentro de estructuras jerárquicas o jerárquicas rotas. |
| LiveSetting |
Obtiene o establece el valor de configuración activo para el elemento especificado, que es compatible con un elemento de automatización que representa una región activa. |
| LocalizedControlType |
Obtiene o establece una cadena de texto localizada que describe el tipo de control que representa el elemento de automatización. |
| LocalizedLandmarkType |
Obtiene o establece una cadena de texto localizada que describe el tipo de punto de referencia que representa el elemento de automatización. |
| Name |
Obtiene o establece el nombre Automatización de la interfaz de usuario del elemento. |
| PositionInSet |
Obtiene o establece un entero basado en 1 que describe la ubicación ordinal del elemento dentro de un conjunto de elementos que se consideran elementos relacionados. |
| SizeOfSet |
Obtiene o establece el número de elementos de un conjunto de elementos que se consideran relacionados. |
Métodos
| GetAcceleratorKey(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.AcceleratorKey para dependencyObject especificado. |
| GetAccessibilityView(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.AccessibilityView para dependencyObject especificado. |
| GetAccessKey(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.AccessKey para dependencyObject especificado. |
| GetAnnotations(DependencyObject) |
Obtiene el valor de la propiedad AutomationProperties.Annotations para dependencyObject especificado. |
| GetAutomationControlType(UIElement) |
Obtiene el valor de la propiedad adjunta AutomationProperties.AutomationControlType para dependencyObject especificado. |
| GetAutomationId(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.AutomationId para dependencyObject especificado. |
| GetControlledPeers(DependencyObject) |
Método de utilidad estática que recupera la lista de elementos del mismo nivel controlados de un propietario de destino. |
| GetCulture(DependencyObject) |
Obtiene el valor de la propiedad adjunta XAML culture para dependencyObject especificado. |
| GetDescribedBy(DependencyObject) |
Obtiene una colección de elementos que proporcionan más información sobre el elemento de automatización especificado. |
| GetFlowsFrom(DependencyObject) |
Obtiene una lista de elementos de automatización que sugieren el orden de lectura antes del elemento de automatización especificado. |
| GetFlowsTo(DependencyObject) |
Obtiene una lista de elementos de automatización que sugieren el orden de lectura después del elemento de automatización especificado. |
| GetFullDescription(DependencyObject) |
Obtiene el valor de la propiedad AutomationProperties.FullDescription para dependencyObject especificado. |
| GetHeadingLevel(DependencyObject) |
Obtiene el valor de la propiedad AutomationProperties.HeadingLevel para dependencyObject especificado. |
| GetHelpText(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.HelpText para dependencyObject especificado. |
| GetIsDataValidForForm(DependencyObject) |
Obtiene el valor de la propiedad AutomationProperties.IsDataValidForForm para dependencyObject especificado. |
| GetIsDialog(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.IsDialog para dependencyObject especificado. |
| GetIsPeripheral(DependencyObject) |
Obtiene un valor booleano que indica si el elemento especificado representa la interfaz de usuario periférica. |
| GetIsRequiredForForm(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.IsRequiredForForm para dependencyObject especificado. |
| GetItemStatus(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.ItemStatus para dependencyObject especificado. |
| GetItemType(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.ItemType para dependencyObject especificado. |
| GetLabeledBy(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.LabeledBy para dependencyObject especificado. |
| GetLandmarkType(DependencyObject) |
Obtiene el valor de la propiedad adjunta del tipo de punto de referencia para dependencyObject especificado. |
| GetLevel(DependencyObject) |
Obtiene el valor de la propiedad AutomationProperties.Level para el elemento especificado. |
| GetLiveSetting(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.LiveSetting para dependencyObject especificado. |
| GetLocalizedControlType(DependencyObject) |
Obtiene una cadena localizada que indica el tipo del control especificado. |
| GetLocalizedLandmarkType(DependencyObject) |
Obtiene el valor de la propiedad adjunta del tipo de punto de referencia localizado para dependencyObject especificado. |
| GetName(DependencyObject) |
Obtiene el valor de la propiedad adjunta AutomationProperties.Name para dependencyObject especificado. |
| GetPositionInSet(DependencyObject) |
Obtiene el valor de la propiedad AutomationProperties.PositionInSet para dependencyObject especificado. |
| GetSizeOfSet(DependencyObject) |
Obtiene el valor de la propiedad AutomationProperties.SizeOfSet para dependencyObject especificado. |
| SetAcceleratorKey(DependencyObject, String) |
Establece el valor de la propiedad adjunta AutomationProperties.AcceleratorKey para dependencyObject especificado. |
| SetAccessibilityView(DependencyObject, AccessibilityView) |
Establece el valor de la propiedad adjunta AutomationProperties.AccessibilityView para dependencyObject especificado. |
| SetAccessKey(DependencyObject, String) |
Establece el valor de la propiedad adjunta AutomationProperties.AccessKey para dependencyObject especificado. |
| SetAutomationControlType(UIElement, AutomationControlType) |
Establece el valor de la propiedad adjunta AutomationProperties.AutomationControlType para dependencyObject especificado. |
| SetAutomationId(DependencyObject, String) |
Establece el valor de la propiedad adjunta AutomationProperties.AutomationId para dependencyObject especificado. |
| SetCulture(DependencyObject, Int32) |
Establece el valor de la propiedad adjunta Culture para dependencyObject especificado. |
| SetFullDescription(DependencyObject, String) |
Establece una cadena localizada que describe la apariencia visual o el contenido del dependencyObject especificado. |
| SetHeadingLevel(DependencyObject, AutomationHeadingLevel) |
Establece el valor de la propiedad AutomationProperties.HeadingLevel para dependencyObject especificado. |
| SetHelpText(DependencyObject, String) |
Establece el valor de la propiedad adjunta AutomationProperties.HelpText para dependencyObject especificado. |
| SetIsDataValidForForm(DependencyObject, Boolean) |
Establece un valor booleano que indica si el valor especificado o seleccionado es válido para la regla de formulario asociada al elemento especificado. |
| SetIsDialog(DependencyObject, Boolean) |
Establece un valor booleano que indica si el elemento especificado debe identificarse como una ventana de diálogo. |
| SetIsPeripheral(DependencyObject, Boolean) |
Establece un valor booleano que indica si el elemento especificado representa la interfaz de usuario periférica. |
| SetIsRequiredForForm(DependencyObject, Boolean) |
Establece el valor de la propiedad adjunta AutomationProperties.IsRequiredForForm para dependencyObject especificado. |
| SetItemStatus(DependencyObject, String) |
Establece el valor de la propiedad adjunta AutomationProperties.ItemStatus para dependencyObject especificado. |
| SetItemType(DependencyObject, String) |
Establece el valor de la propiedad adjunta AutomationProperties.ItemType para dependencyObject especificado. |
| SetLabeledBy(DependencyObject, UIElement) |
Establece el valor de la propiedad adjunta AutomationProperties.LabeledBy para dependencyObject especificado. |
| SetLandmarkType(DependencyObject, AutomationLandmarkType) |
Establece el valor de la propiedad adjunta del tipo de punto de referencia para dependencyObject especificado. |
| SetLevel(DependencyObject, Int32) |
Establece el valor de la propiedad adjunta AutomationProperties.Level para dependencyObject especificado. |
| SetLiveSetting(DependencyObject, AutomationLiveSetting) |
Establece el valor de la propiedad adjunta AutomationProperties.LiveSetting para dependencyObject especificado. |
| SetLocalizedControlType(DependencyObject, String) |
Establece una cadena localizada que indica el tipo del control especificado. |
| SetLocalizedLandmarkType(DependencyObject, String) |
Establece el valor de la propiedad adjunta del tipo de punto de referencia localizado para dependencyObject especificado. |
| SetName(DependencyObject, String) |
Establece el valor de la propiedad adjunta AutomationProperties.Name para dependencyObject especificado. |
| SetPositionInSet(DependencyObject, Int32) |
Establece el valor de la propiedad adjunta AutomationProperties.PositionInSet para dependencyObject especificado. |
| SetSizeOfSet(DependencyObject, Int32) |
Establece el valor de la propiedad adjunta AutomationProperties.SizeOfSet para dependencyObject especificado. |