Partager via

AutomationProperties Classe

  • Référence

Définition

Espace de noms:
Microsoft.UI.Xaml.Automation
Modifier

Fournit la prise en charge de l’obtention ou de la définition des valeurs au niveau de l’instance des propriétés d’automatisation. Ces valeurs de propriété sont définies en tant que propriétés jointes (généralement en XAML) et complètent ou remplacent les valeurs de propriété Automation à partir des AutomationPeerd’un contrôle.

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
Héritage
Object Platform::Object IInspectable AutomationProperties
Attributs
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarques

Propriétés jointes XAML

AutomationProperties est la classe de service hôte pour plusieurs propriétés jointes XAML . L’objectif de ces propriétés jointes est d’activer la définition de différentes valeurs par instance pertinentes pour la façon dont un élément d’interface utilisateur est signalé à l’infrastructure d’accessibilité Microsoft UI Automation. Cela est utile dans les cas où la conception de classe de l’élément d’interface utilisateur ne transfère pas déjà d’autres valeurs de propriété liées à l’interface utilisateur dans le cadre de son comportement d’intégration ou d’implémentation d’homologues Microsoft UI Automation, ou où la valeur transférée n’est pas la valeur que vous souhaitez signaler à Microsoft UI Automation.

Pour prendre en charge l’accès au processeur XAML aux propriétés jointes, ainsi que pour exposer des opérations d’obtention et de définition équivalentes au code, chaque propriété jointe XAML a une paire de Get et Set méthodes d’accesseur, qui sont également membres d’AutomationProperties. Par exemple, les méthodes GetName et SetName prennent en charge et fournissent la prise en charge équivalente du code uniquement pour la création de rapports d’automatisation nom valeurs à Microsoft UI Automation, au lieu d’utiliser la propriété jointe Name pour la définir en XAML. Vous pouvez également utiliser le système de propriétés de dépendance pour obtenir ou définir la valeur de la propriété jointe, et cela signale également la valeur sous-jacente à Microsoft UI Automation. Appelez GetValue ou SetValue, en passant les arguments de l’identificateur de propriété de dépendance à définir et une référence à l’objet cible sur lequel obtenir ou définir la valeur.

Name, propriété

Parmi les différentes propriétés jointes, probablement la plus importante est Name. Cela est dû au fait qu’il s’agit de la propriété Name qui est la plus fréquemment sollicitée et signalée par la technologie d’assistance lorsque les utilisateurs interagissent avec une application dans un scénario d’accessibilité. Le Name sert d’identificateur lisible par l’utilisateur pour l’élément d’interface utilisateur.

Différents éléments d’interface utilisateur ont un transfert d’homologue qui peut fournir une valeur de Name par défaut en fonction d’autres propriétés d’élément. Par exemple, le transfert d’homologue pour la classe Button transfère l’évaluation ToString du contenu button et utilise cette chaîne comme Namepar défaut. Pour remplacer cette valeur par défaut, ou pour fournir une valeur Name pour tout élément d’interface utilisateur où aucun nom microsoft UI Automation Name n’est disponible, définissez la propriété Name jointe sur cet élément en XAML. Pour plus d’informations sur la raison pour laquelle une nom de microsoft UI Automation est importante, consultez informations d’accessibilité de base. Pour plus d’informations sur la façon de tester si un élément a déjà un Name fourni par un homologue utile, consultez de test d’accessibilité.

Pour des raisons de localisation, vous devez éviter les valeurs de chaîne codées en dur pour l'Name en XAML. Si vous définissez directive x :Uid sur l’élément, vous pouvez utiliser des ressources RESW pour cibler la propriété et fournir des valeurs différentes pour la localisation. Pour les propriétés jointes, le formulaire d’identificateur de ressource nécessite une qualification complète de la propriété jointe dans le formulaire XAML, y compris son espace de noms et un préfixe utilisant : Par exemple, pour cibler la valeur de propriété jointe AutomationProperties.Name sur une ressource qui a directive x :Uid valeur de « sendButton », le nom valeur de l’élément de données de données dans les ressources RESW est

Propriétés jointes

Note

Pour plus d’informations sur chaque propriété jointe, consultez la page du champ Identificateur de la propriété.

Propriété jointe Description
AcceleratorKey Obtient ou définit la touche d’accélérateur de l’élément spécifié.
AccessibilityView Obtient ou définit le mode d’arborescence Microsoft UI Automation pour un élément.
AccessKey Obtient ou définit la clé d’accès de l’élément spécifié.
AutomationId Obtient ou définit la chaîne qui identifie de manière unique l’élément sur Microsoft UI Automation.
Culture Obtient ou définit l’identificateur de paramètres régionaux de l’élément Automation (par exemple, 0x0409 pour «en-US» ou anglais (États-Unis)).Valeur de la propriété de culture pour l’élément spécifié.
FullDescription Obtient ou définit une chaîne localisée contenant du texte de description étendu pour un élément.
HeadingLevel Obtient ou définit le niveau de titre d’un élément UI Automation.
HelpText Obtient ou définit le texte d’aide de l’élément.
IsDataValidForForm Obtient ou définit une valeur qui indique si les données sont valides pour le formulaire.
IsDialog Obtient ou définit une valeur qui indique si l’élément Automation est une fenêtre de dialogue.
IsPeripheral Obtient ou définit une valeur qui indique si l’élément Automation représente l’interface utilisateur périphérique.
IsRequiredForForm Obtient ou définit une valeur qui indique si l’élément doit être rempli sur un formulaire.
ItemStatus Obtient ou définit une description de l’état d’un élément dans un élément.
ItemType Obtient ou définit une description du type de l’élément spécifié.
LabeledBy Obtient ou définit l’élément qui contient l’étiquette de texte de l’élément.
LandmarkType Obtient ou définit un Identificateur de type de repère associé à un élément.
Niveau Obtient ou définit un entier basé sur 1 qui décrit l’emplacement d’un élément à l’intérieur de structures hiérarchiques ou rompues.
LiveSetting Obtient ou définit la valeur de paramètre actif pour l’élément spécifié.
LocalizedControlType Obtient ou définit une chaîne de texte localisée qui décrit le type de contrôle que l’élément Automation représente.
LocalizedLandmarkType Obtient ou définit une chaîne de texte localisée qui décrit le type de repère que l’élément Automation représente.
Nom Obtient ou définit le nom UI Automation de l’élément.
PositionInSet Obtient ou définit un entier basé sur 1 qui décrit l’emplacement ordinal de l’élément dans un ensemble d’éléments considérés comme frères.
SizeOfSet Obtient ou définit le nombre d’éléments d’un ensemble d’éléments considérés comme frères.

Propriétés

AcceleratorKeyProperty

Identifie la propriété jointe AutomationProperties.AcceleratorKey, qui est une chaîne contenant les combinaisons de touche d’accélérateur (également appelée touche de raccourci) pour l’élément Automation.
AccessibilityViewProperty

Identifie la propriété jointe AutomationProperties.AccessibilityView. Définissez cette propriété jointe sur des éléments individuels afin de modifier leur visibilité d’élément en modes spécifiques demandés par un client UI Automation.
AccessKeyProperty

Identifie la propriété jointe AutomationProperties.AccessKey, qui est une chaîne contenant le caractère de clé d’accès pour l’élément Automation.
AnnotationsProperty

Identifie une propriété de dépendance utilisée pour une liste d’objets d’annotation dans un document, comme le commentaire, l’en-tête, le pied de page, etc.
AutomationControlTypeProperty

Identifie la propriété jointe AutomationProperties, qui est une Microsoft.UI.Xaml.Automation.Peer.AutomationControlType.
AutomationIdProperty

Identifie la propriété jointe AutomationProperties.AutomationId, qui est une chaîne contenant l’identificateur UI Automation (ID) de l’élément Automation.
ControlledPeersProperty

Identifie la propriété jointe ControlledPeers, qui est utilisée pour une collection d’éléments d’automatisation qui peuvent être manipulés par l’élément Automation spécifié.
CultureProperty

Obtient l’identificateur de la propriété jointe de culture qui contient un identificateur de paramètres régionaux pour l’élément Automation (par exemple, 0x0409 pour «en-US» ou anglais (États-Unis)).
DescribedByProperty

Obtient l’identificateur de la propriété jointe décrite, qui est un tableau d’éléments qui fournissent plus d’informations sur l’élément Automation.
FlowsFromProperty

Obtient l’identificateur de la propriété jointe FlowsFrom, qui est un tableau d’éléments d’automatisation qui suggère l’ordre de lecture avant l’élément Automation actuel.
FlowsToProperty

Obtient l’identificateur du FlowTo propriété jointe, qui est un tableau d’éléments d’automatisation qui suggère l’ordre de lecture après l’élément Automation actuel.
FullDescriptionProperty

Obtient l’identificateur de la propriété jointe de description complète, qui expose une chaîne localisée contenant du texte de description étendu pour un élément.
HeadingLevelProperty

Obtient l’identificateur de la propriété jointe HeadingLevel, qui indique le niveau de titre d’un élément UI Automation.
HelpTextProperty

Identifie la propriété jointe AutomationProperties.HelpText, qui est une chaîne de texte d’aide associée à l’élément Automation.
IsDataValidForFormProperty

Identifie la propriété de dépendance booléenne qui indique si les données sont valides pour le formulaire.
IsDialogProperty

Identifie la AutomationProperties.IsDialog propriété jointe, qui est une valeur booléenne qui indique si l’élément Automation est une fenêtre de dialogue.
IsPeripheralProperty

Identifie la propriété de dépendance booléenne qui indique si l’élément Automation représente l’interface utilisateur périphérique.
IsRequiredForFormProperty

Identifie la propriété jointe AutomationProperties.IsRequiredForForm, qui est une valeur booléenne qui indique si l’élément Automation doit être rempli sur un formulaire.
ItemStatusProperty

Identifie la propriété jointe ItemStatus, qui décrit l’état d’un élément d’automatisation.
ItemTypeProperty

Identifie la propriété jointe AutomationProperties.ItemType, qui est une chaîne de texte décrivant le type de l’élément Automation.
LabeledByProperty

Identifie la propriété jointe AutomationProperties.LabeledBy, qui est un élément Automation qui contient l’étiquette de texte de cet élément.
LandmarkTypeProperty

Obtient l’identificateur de la propriété jointe de type de repère, qui est un identificateur de type de repère associé à un élément.
LevelProperty

Obtient l’identificateur de la propriété jointe Level, qui est un entier basé sur 1 associé à un élément Automation.
LiveSettingProperty

Identifie la propriété jointe AutomationProperties.LiveSetting prise en charge par un élément Automation qui représente une région dynamique.
LocalizedControlTypeProperty

Identifie la propriété de dépendance de type de contrôle localisée, qui est une chaîne de texte décrivant le type de contrôle que l’élément Automation représente.
LocalizedLandmarkTypeProperty

Obtient l’identificateur de la propriété jointe de type de repère localisé, qui est une chaîne de texte localisée décrivant le type de repère que l’élément Automation représente.
NameProperty

Identifie la AutomationProperties.Name propriété jointe, qui est une chaîne qui contient le nom de l’élément Automation.
PositionInSetProperty

Obtient l’identificateur de la propriété jointe PositionInSet, qui est un entier basé sur 1 associé à un élément Automation.
SizeOfSetProperty

Obtient l’identificateur de la propriété jointe.

Propriétés attachées

AcceleratorKey

Obtient ou définit une chaîne contenant les combinaisons de touche d’accélérateur (également appelée touche de raccourci) pour l’élément Automation.
AccessibilityView

Obtient ou définit le mode d’arborescence Microsoft UI Automation pour un élément.
AccessKey

Obtient ou définit une chaîne contenant le caractère de clé d’accès pour l’élément Automation.
Annotations

Obtient une liste d’objets d’annotation dans un document, tel que le commentaire, l’en-tête, le pied de page, etc.
AutomationControlType

Identifie le type d’élément d’interface utilisateur exposé au client Microsoft UI Automation.
AutomationId

Obtient ou définit la chaîne qui identifie de manière unique l’élément sur Microsoft UI Automation.
ControlledPeers

Obtient une collection d’éléments d’automatisation qui peuvent être manipulés par l’élément Automation spécifié.
Culture

Obtient ou définit l’identificateur de paramètres régionaux de l’élément Automation (par exemple, 0x0409 pour «en-US» ou anglais (États-Unis)).
DescribedBy

Obtient un tableau d’éléments qui fournissent plus d’informations sur l’élément Automation.
FlowsFrom

Obtient un tableau d’éléments d’automatisation qui suggère l’ordre de lecture avant l’élément Automation actuel.
FlowsTo

Obtient un tableau d’éléments d’automatisation qui suggère l’ordre de lecture après l’élément Automation actuel.
FullDescription

Obtient ou définit une chaîne localisée contenant du texte de description étendu pour un élément.
HeadingLevel

Obtient ou définit le niveau de titre d’un élément UI Automation.
HelpText

Obtient ou définit une chaîne de texte d’aide associée à l’élément Automation.
IsDataValidForForm

Obtient ou définit une valeur qui indique si les données sont valides pour le formulaire.
IsDialog

Obtient ou définit une valeur qui indique si l’élément Automation est une fenêtre de dialogue.
IsPeripheral

Obtient ou définit une valeur qui indique si l’élément Automation représente l’interface utilisateur périphérique.
IsRequiredForForm

Obtient ou définit une valeur qui indique si l’élément doit être rempli sur un formulaire.
ItemStatus

Obtient ou définit une description de l’état d’un élément dans un élément.
ItemType

Obtient ou définit une description du type de l’élément spécifié.
LabeledBy

Obtient ou définit l’élément Automation qui contient l’étiquette de texte de cet élément.
LandmarkType

Obtient ou définit un Identificateur de type de repère associé à un élément.
Level

Obtient ou définit un entier basé sur 1 qui décrit l’emplacement d’un élément à l’intérieur de structures hiérarchiques ou rompues.
LiveSetting

Obtient ou définit la valeur de paramètre actif de l’élément spécifié, qui est prise en charge par un élément Automation qui représente une région dynamique.
LocalizedControlType

Obtient ou définit une chaîne de texte localisée qui décrit le type de contrôle que l’élément Automation représente.
LocalizedLandmarkType

Obtient ou définit une chaîne de texte localisée qui décrit le type de repère que l’élément Automation représente.
Name

Obtient ou définit le nom UI Automation de l’élément.
PositionInSet

Obtient ou définit un entier basé sur 1 qui décrit l’emplacement ordinal de l’élément dans un ensemble d’éléments considérés comme frères.
SizeOfSet

Obtient ou définit le nombre d’éléments d’un ensemble d’éléments considérés comme frères.

Méthodes

GetAcceleratorKey(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.AcceleratorKey pour la DependencyObjectspécifiée.
GetAccessibilityView(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.AccessibilityView pour leDependencyObject spécifié.
GetAccessKey(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.AccessKey pour le DependencyObject spécifié.
GetAnnotations(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.Annotations pour la DependencyObjectspécifiée.
GetAutomationControlType(UIElement)

Obtient la Microsoft.UI.Xaml.Automation.Peer.AutomationControlType pour l’élément d’interface utilisateur spécifié.
GetAutomationId(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.AutomationId pour la DependencyObjectspécifiée.
GetControlledPeers(DependencyObject)

Méthode d’utilitaire statique qui récupère la liste des homologues contrôlés d’un propriétaire cible.
GetCulture(DependencyObject)

Obtient la valeur de la propriété jointe CultureProperty pour la DependencyObjectspécifiée.
GetDescribedBy(DependencyObject)

Obtient une collection d’éléments qui fournissent plus d’informations sur l’élément Automation spécifié.
GetFlowsFrom(DependencyObject)

Obtient une liste d’éléments d’automatisation qui suggère l’ordre de lecture avant l’élément Automation spécifié.
GetFlowsTo(DependencyObject)

Obtient une liste d’éléments d’automatisation qui suggère l’ordre de lecture après l’élément Automation spécifié.
GetFullDescription(DependencyObject)

Obtient une chaîne localisée qui décrit l’apparence visuelle ou le contenu du DependencyObject spécifié.
GetHeadingLevel(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.HeadingLevel pour la DependencyObjectspécifiée.
GetHelpText(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.HelpText pour laDependencyObject spécifiée.
GetIsDataValidForForm(DependencyObject)

Obtient une valeur booléenne qui indique si la valeur entrée ou sélectionnée est valide pour la règle de formulaire associée à l’élément spécifié.
GetIsDialog(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.IsDialog pour le DependencyObject spécifié.
GetIsPeripheral(DependencyObject)

Obtient une valeur booléenne qui indique si l’élément spécifié représente l’interface utilisateur périphérique.
GetIsRequiredForForm(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.IsRequiredForForm pour la propriété jointe DependencyObject spécifiée.
GetItemStatus(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.ItemStatus pour la DependencyObjectspécifiée.
GetItemType(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.ItemType pour l’objet DependencyObjectspécifié .
GetLabeledBy(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.LabeledBy pour l’objet DependencyObjectspécifié .
GetLandmarkType(DependencyObject)

Obtient la valeur de la propriété jointe de type de repère pour la DependencyObject spécifiée.
GetLevel(DependencyObject)

Obtient la valeur de la propriété pour le .
GetLiveSetting(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.LiveSetting pour la DependencyObjectspécifiée.
GetLocalizedControlType(DependencyObject)

Obtient une chaîne localisée qui indique le type du contrôle spécifié.
GetLocalizedLandmarkType(DependencyObject)

Obtient la valeur de la propriété jointe de type repère localisé pour la DependencyObjectspécifiée.
GetName(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.Name pour la DependencyObjectspécifiée.
GetPositionInSet(DependencyObject)

Obtient la valeur de la propriété pour le .
GetSizeOfSet(DependencyObject)

Obtient la valeur de la propriété pour le .
SetAcceleratorKey(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.AcceleratorKey pour la DependencyObjectspécifiée.
SetAccessibilityView(DependencyObject, AccessibilityView)

Définit la valeur de la propriété jointe AutomationProperties.AccessibilityView pour la DependencyObjectspécifiée.
SetAccessKey(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.AccessKey pour la DependencyObjectspécifiée.
SetAutomationControlType(UIElement, AutomationControlType)

Définit le Microsoft.UI.Xaml.Automation.Peer.AutomationControlType pour l’élément d’interface utilisateur spécifié.
SetAutomationId(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.AutomationId pour laDependencyObject spécifiée.
SetCulture(DependencyObject, Int32)

Définit la valeur de la propriété jointe CultureProperty pour la DependencyObjectspécifiée.
SetFullDescription(DependencyObject, String)

Définit une chaîne localisée qui décrit l’apparence visuelle ou le contenu du DependencyObject spécifié.
SetHeadingLevel(DependencyObject, AutomationHeadingLevel)

Définit la valeur de la propriété AutomationProperties.HeadingLevel pour la DependencyObjectspécifiée.
SetHelpText(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.HelpText pour la DependencyObjectspécifiée.
SetIsDataValidForForm(DependencyObject, Boolean)

Définit une valeur booléenne qui indique si la valeur entrée ou sélectionnée est valide pour la règle de formulaire associée à l’élément spécifié.
SetIsDialog(DependencyObject, Boolean)

Définit une valeur booléenne qui indique si l’élément spécifié doit être identifié comme une fenêtre de boîte de dialogue.
SetIsPeripheral(DependencyObject, Boolean)

Définit une valeur booléenne qui indique si l’élément spécifié représente l’interface utilisateur périphérique.
SetIsRequiredForForm(DependencyObject, Boolean)

Définit la valeur de la propriété jointe AutomationProperties.IsRequiredForForm pour la propriété jointe DependencyObject spécifiée.
SetItemStatus(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.ItemStatus pour la DependencyObjectspécifiée.
SetItemType(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.ItemType pour la DependencyObjectspécifiée.
SetLabeledBy(DependencyObject, UIElement)

Définit la valeur de la propriété jointe AutomationProperties.LabeledBy pour la DependencyObjectspécifiée.
SetLandmarkType(DependencyObject, AutomationLandmarkType)

Définit la valeur de la propriété jointe de type de repère pour l'DependencyObjectspécifié.
SetLevel(DependencyObject, Int32)

Définit la valeur de la propriété jointe AutomationProperties.Level pour la DependencyObjectspécifiée.
SetLiveSetting(DependencyObject, AutomationLiveSetting)

Définit la valeur de la propriété jointe AutomationProperties.LiveSetting pour la DependencyObjectspécifiée.
SetLocalizedControlType(DependencyObject, String)

Définit une chaîne localisée qui indique le type du contrôle spécifié.
SetLocalizedLandmarkType(DependencyObject, String)

Définit la valeur de la propriété jointe de type de repère localisé pour l'DependencyObject spécifié.
SetName(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.Name pour la DependencyObjectspécifiée.
SetPositionInSet(DependencyObject, Int32)

Définit la valeur de la propriété jointe AutomationProperties.PositionInSet pour la DependencyObjectspécifiée.
SetSizeOfSet(DependencyObject, Int32)

Définit la valeur de la propriété jointe AutomationProperties.SizeOfSet pour la DependencyObjectspécifiée.

S’applique à

Voir aussi