AutomationProperties Clase

  • Referencia

Definición

Espacio de nombres:
Microsoft.UI.Xaml.Automation
Editar

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(Microsoft.UI.Xaml.WinUIContract, 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(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AutomationProperties
Public NotInheritable Class AutomationProperties
Herencia
Object Platform::Object IInspectable AutomationProperties
Atributos
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Comentarios

Propiedades adjuntas xaml

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 Automatización de la interfaz de usuario de Microsoft. Esto resulta ú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 implementación de automatización de la interfaz de usuario de Microsoft o en los que el valor que se reenvía no es el valor que desea notificar a Microsoft UI Automation.

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 de Nombre de automatización a automatización de la interfaz de usuario de Microsoft, 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 Automatización de la interfaz de usuario de Microsoft. 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 automatización de la interfaz de usuario de Microsoft disponible, establezca la propiedad adjunta Name en ese elemento en XAML. Para obtener más información sobre por qué un nombre de automatización de la interfaz de usuario de Microsoft 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

Propiedades adjuntas

Nota:

Para obtener más información sobre cada propiedad adjunta, consulta la página del campo Identificador de la propiedad.

Propiedad adjunta Descripción
AcceleratorKey Obtiene o establece la tecla de aceleración para el elemento especificado.
AccessibilityView Obtiene o establece el modo de vista de árbol de Automatización de la interfaz de usuario de Microsoft para un elemento.
AccessKey Obtiene o establece la clave de acceso para el elemento especificado.
AutomationId Obtiene o establece la cadena que identifica de forma única el elemento a Automatización de la interfaz de usuario de Microsoft.
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)).Valor de la propiedad culture para el elemento especificado.
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 de Automatización de la interfaz de usuario.
HelpText Obtiene o establece el texto de ayuda del elemento.
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 que contiene la etiqueta de texto del elemento.
LandmarkType Obtiene o establece un identificador de tipo de punto de referencia asociado a un elemento .
Nivel 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.
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.
Nombre Obtiene o establece el nombre de 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.

Propiedades

AcceleratorKeyProperty

Identifica la propiedad adjunta AutomationProperties.AcceleratorKey , que es 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.
AccessibilityViewProperty

Identifica la propiedad adjunta AutomationProperties.AccessibilityView . Establezca esta propiedad adjunta en elementos individuales para cambiar su visibilidad de elementos a modos específicos solicitados por un cliente de Automatización de la interfaz de usuario.
AccessKeyProperty

Identifica la propiedad adjunta AutomationProperties.AccessKey , que es una cadena que contiene el carácter de clave de acceso para el elemento de automatización.
AnnotationsProperty

Identifica una propiedad de dependencia que se usa para una lista de objetos de anotación en un documento, como comentario, encabezado, pie de página, etc.
AutomationControlTypeProperty

Identifica la AutomationProperties propiedad adjunta, que es .Microsoft.UI.Xaml.Automation.Peers.AutomationControlType
AutomationIdProperty

Identifica la propiedad adjunta AutomationProperties.AutomationId , que es una cadena que contiene el identificador (ID) de automatización de la interfaz de usuario para el elemento de automatización.
ControlledPeersProperty

Identifica la propiedad adjunta ControlledPeers, que se usa para una colección de elementos de automatización que el elemento de automatización especificado puede manipular.
CultureProperty

Obtiene el identificador de la propiedad adjunta de referencia cultural que contiene un identificador de configuración regional para el elemento de automatización (por ejemplo, 0x0409 para "en-US" o inglés (Estados Unidos)).
DescribedByProperty

Obtiene el identificador de la propiedad adjunta descrita, que es una matriz de elementos que proporcionan más información sobre el elemento de automatización.
FlowsFromProperty

Obtiene el identificador de la propiedad adjunta FlowsFrom , que es una matriz de elementos de automatización que sugiere el orden de lectura antes del elemento de automatización actual.
FlowsToProperty

Obtiene el identificador de la propiedad adjunta FlowsTo , que es una matriz de elementos de automatización que sugiere el orden de lectura después del elemento de automatización actual.
FullDescriptionProperty

Obtiene el identificador de la propiedad adjunta de descripción completa, que expone una cadena localizada que contiene texto de descripción extendido para un elemento.
HeadingLevelProperty

Obtiene el identificador de la propiedad adjunta HeadingLevel , que indica el nivel de encabezado de un elemento de Automatización de la interfaz de usuario.
HelpTextProperty

Identifica la propiedad adjunta AutomationProperties.HelpText , que es una cadena de texto de ayuda asociada al elemento automation.
IsDataValidForFormProperty

Identifica la propiedad de dependencia booleana que indica si los datos son válidos para el formulario.
IsDialogProperty

Identifica la propiedad adjunta AutomationProperties.IsDialog , que es un valor booleano que indica si el elemento de automatización es una ventana de diálogo.
IsPeripheralProperty

Identifica la propiedad de dependencia booleana que indica si el elemento de automatización representa la interfaz de usuario periférica.
IsRequiredForFormProperty

Identifica la propiedad adjunta AutomationProperties.IsRequiredForForm , que es un valor booleano que indica si es necesario rellenar el elemento de automatización en un formulario.
ItemStatusProperty

Identifica la propiedad adjunta ItemStatus, que describe el estado de un elemento de elemento de automatización.
ItemTypeProperty

Identifica la propiedad adjunta AutomationProperties.ItemType , que es una cadena de texto que describe el tipo del elemento de automatización.
LabeledByProperty

Identifica la propiedad adjunta AutomationProperties.LabeledBy , que es un elemento de automatización que contiene la etiqueta de texto de este elemento.
LandmarkTypeProperty

Obtiene el identificador de la propiedad adjunta del tipo de punto de referencia, que es un identificador de tipo de punto de referencia asociado a un elemento .
LevelProperty

Obtiene el identificador de la propiedad adjunta Level , que es un entero basado en 1 asociado a un elemento de automatización.
LiveSettingProperty

Identifica la propiedad adjunta AutomationProperties.LiveSetting , que es compatible con un elemento de automatización que representa una región activa.
LocalizedControlTypeProperty

Identifica la propiedad de dependencia del tipo de control localizado, que es una cadena de texto que describe el tipo de control que representa el elemento de automatización.
LocalizedLandmarkTypeProperty

Obtiene el identificador de la propiedad adjunta del tipo de punto de referencia localizado, que es una cadena de texto localizada que describe el tipo de punto de referencia que representa el elemento de automatización.
NameProperty

Identifica la propiedad adjunta AutomationProperties.Name , que es una cadena que contiene el nombre del elemento de automatización.
PositionInSetProperty

Obtiene el identificador de la propiedad adjunta PositionInSet , que es un entero basado en 1 asociado a un elemento de automatización.
SizeOfSetProperty

Obtiene el identificador de la propiedad adjunta.

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 Automatización de la interfaz de usuario de Microsoft 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

Identifica el tipo de elemento de interfaz de usuario (UI) que se expone al cliente de Automatización de la interfaz de usuario de Microsoft.
AutomationId

Obtiene o establece la cadena que identifica de forma única el elemento a Automatización de la interfaz de usuario de Microsoft.
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 de 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 de 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 para Microsoft.UI.Xaml.Automation.Peers.AutomationControlType el elemento de interfaz de usuario 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 CultureProperty 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 una cadena localizada que describe la apariencia visual o el contenido del 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 un valor booleano que indica si el valor especificado o seleccionado es válido para la regla de formulario asociada al elemento 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 para el 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 para el especificado.
GetSizeOfSet(DependencyObject)

Obtiene el valor de la propiedad para el 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 para Microsoft.UI.Xaml.Automation.Peers.AutomationControlType el elemento de interfaz de usuario 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 CultureProperty 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.

Se aplica a

Consulte también