AutomationProperties Classe

Définition

Prend en charge l’obtention ou la définition de valeurs de niveau 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 de l’AutomationPeer d’un contrôle.

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 AutomationProperties
Public NotInheritable Class AutomationProperties
Héritage
Object Platform::Object IInspectable AutomationProperties
Attributs

Configuration requise pour Windows

Famille d’appareils
Windows 10 (introduit dans 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

Conseil

Ouvrez l’application WinUI 3 Gallery et consultez les principes d’accessibilité suivants en action :

L’application Galerie WinUI 3 inclut des exemples interactifs de la plupart des contrôles, fonctionnalités et fonctionnalités WinUI 3. Obtenir l’application à partir du Microsoft Store ou obtenir le code source sur GitHub

Remarques

AutomationProperties est la classe de service hôte pour plusieurs propriétés jointes XAML. L’objectif de ces propriétés jointes est de permettre 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 microsoft UI Automation ou d’implémentation d’homologue, ou lorsque la valeur transférée n’est pas la valeur que vous souhaitez signaler à Microsoft UI Automation.

Pour prendre en charge l’accès du processeur XAML aux propriétés jointes, ainsi que pour exposer des opérations get et set équivalentes au code, chaque propriété jointe XAML a une paire de méthodes d’accesseur Get et Set , qui sont également membres d’AutomationProperties. Par exemple, les méthodes GetName et SetName prennent en charge et fournissent la prise en charge du code uniquement équivalente pour la création de rapports de valeurs nom automation à 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, ce qui 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.

Nom de la propriété

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

Divers éléments d’interface utilisateur ont un transfert d’homologue qui peut fournir une valeur Name par défaut basée sur 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 nom par défaut. Pour remplacer cette valeur par défaut, ou pour fournir une valeur Name pour tout cas d’élément d’interface utilisateur où microsoft UI Automation Name n’est pas disponible, définissez la propriété Name jointe sur cet élément en XAML. Pour plus d’informations sur l’importance d’un nom microsoft UI Automation, consultez Informations de base sur l’accessibilité. Pour plus d’informations sur la façon de tester si un élément a déjà un nom fourni par l’homologue qui est utile, consultez Tests d’accessibilité.

Pour des raisons de localisation, vous devez éviter les valeurs de chaîne codées en dur pour le Nom en XAML. Si vous définissez la directive x:Uid sur l’élément, vous pouvez utiliser les ressources RESW pour cibler la propriété et fournir différentes valeurs 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 using:. Par exemple, pour cibler la valeur de propriété jointe AutomationProperties.Name sur une ressource dont la valeur de directive x:Uid est « sendButton », la valeur de nom de l’élément de données dans les ressources RESW est sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name

Consultez Propriétés jointes pour obtenir une liste complète (pour plus d’informations sur chaque propriété jointe, voir le champ Identificateur de chaque propriété).

Historique des versions

Version de Windows Version du SDK Valeur ajoutée
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

Propriétés

AcceleratorKeyProperty

Identifie la propriété jointe AutomationProperties.AcceleratorKey .

AccessibilityViewProperty

Identifie la propriété jointe AutomationProperties.AccessibilityView .

AccessKeyProperty

Identifie la propriété jointe AutomationProperties.AccessKey .

AnnotationsProperty

Identifie la propriété jointe AutomationProperties.Annotations .

AutomationControlTypeProperty

Identifie la propriété jointe AutomationProperties.AutomationControlType .

AutomationIdProperty

Identifie la propriété jointe AutomationProperties.AutomationId .

ControlledPeersProperty

Identifie la propriété jointe AutomationProperties.ControlledPeers .

CultureProperty

Identifie la propriété jointe AutomationProperties.Culture .

DescribedByProperty

Identifie la propriété jointe AutomationProperties.DescribedBy .

FlowsFromProperty

Identifie la propriété jointe FlowsFrom .

FlowsToProperty

Identifie la propriété jointe FlowsTo .

FullDescriptionProperty

Identifie la propriété jointe XAML AutomationProperties.FullDescription .

HeadingLevelProperty

Identifie la propriété jointe XAML HeadingLevel .

HelpTextProperty

Identifie la propriété jointe XAML AutomationProperties.HelpText .

IsDataValidForFormProperty

Identifie la propriété jointe XAML AutomationProperties.IsDataValidForForm .

IsDialogProperty

Identifie la propriété jointe XAML AutomationProperties.IsDialog .

IsPeripheralProperty

Identifie la propriété jointe XAML AutomationProperties.IsPeripheral .

IsRequiredForFormProperty

Identifie la propriété jointe XAML AutomationProperties.IsRequiredForForm .

ItemStatusProperty

Identifie la propriété jointe XAML AutomationProperties.ItemStatus .

ItemTypeProperty

Identifie la propriété jointe XAML AutomationProperties.ItemType .

LabeledByProperty

Identifie la propriété jointe XAML AutomationProperties.LabeledBy .

LandmarkTypeProperty

Identifie la propriété jointe XAML AutomationProperties.LandmarkType .

LevelProperty

Identifie la propriété jointe XAML AutomationProperties.Level .

LiveSettingProperty

Identifie la propriété jointe XAML AutomationProperties.LiveSetting .

LocalizedControlTypeProperty

Identifie la propriété jointe XAML AutomationProperties.LocalizedControlType , qui est une chaîne de texte décrivant le type de contrôle que l’élément automation représente.

LocalizedLandmarkTypeProperty

Identifie la propriété jointe XAML AutomationProperties.LocalizedLandmarkType .

NameProperty

Identifie la propriété jointe XAML AutomationProperties.Name.

PositionInSetProperty

Identifie la propriété jointe XAML AutomationProperties.PositionInSet .

SizeOfSetProperty

Identifie la propriété jointe XAML AutomationProperties.SizeOfSet .

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, tels que le commentaire, l’en-tête, le pied de page, etc.

AutomationControlType

Obtient ou définit le type de contrôle pour Microsoft UI Automation.

AutomationId

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

ControlledPeers

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

Culture

Obtient ou définit l’identificateur de paramètres régionaux pour 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 renseigné dans un formulaire.

ItemStatus

Obtient ou définit une description du status 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 de base 1 qui décrit l’emplacement d’un élément à l’intérieur de structures hiérarchiques hiérarchiques ou rompues.

LiveSetting

Obtient ou définit la valeur du paramètre actif pour l’élément spécifié, qui est pris 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 point 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 de base 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 l’objet DependencyObject spécifié.

GetAccessibilityView(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.AccessibilityView pour l’objet DependencyObject spécifié.

GetAccessKey(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.AccessKey pour l’objet DependencyObject spécifié.

GetAnnotations(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.Annotations pour le DependencyObject spécifié.

GetAutomationControlType(UIElement)

Obtient la valeur de la propriété jointe AutomationProperties.AutomationControlType pour l’objet DependencyObject spécifié.

GetAutomationId(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.AutomationId pour l’objet DependencyObject spécifié.

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 XAML culture pour l’objet DependencyObject spécifié.

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 Automation qui suggère l’ordre de lecture avant l’élément Automation spécifié.

GetFlowsTo(DependencyObject)

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

GetFullDescription(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.FullDescription pour l’objet DependencyObject spécifié.

GetHeadingLevel(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.HeadingLevel pour l’objet DependencyObject spécifié.

GetHelpText(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.HelpText pour l’objet DependencyObject spécifié.

GetIsDataValidForForm(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.IsDataValidForForm pour l’objet DependencyObject spécifié.

GetIsDialog(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.IsDialog pour l’objet 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 le DependencyObject spécifié.

GetItemStatus(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.ItemStatus pour l’objet DependencyObject spécifié.

GetItemType(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.ItemType pour l’objet DependencyObject spécifié.

GetLabeledBy(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.LabeledBy pour l’objet DependencyObject spécifié.

GetLandmarkType(DependencyObject)

Obtient la valeur de la propriété jointe de type de repère pour l’objet DependencyObject spécifié.

GetLevel(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.Level pour l’élément spécifié.

GetLiveSetting(DependencyObject)

Obtient la valeur de la propriété jointe AutomationProperties.LiveSetting pour l’objet DependencyObject spécifié.

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 de repère localisé pour l’objet DependencyObject spécifié.

GetName(DependencyObject)

Obtient la valeur du AutomationProperties.Name propriété jointe pour l’objet DependencyObject spécifié.

GetPositionInSet(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.PositionInSet pour le DependencyObject spécifié.

GetSizeOfSet(DependencyObject)

Obtient la valeur de la propriété AutomationProperties.SizeOfSet pour l’objet DependencyObject spécifié.

SetAcceleratorKey(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.AcceleratorKey pour l’objet DependencyObject spécifié.

SetAccessibilityView(DependencyObject, AccessibilityView)

Définit la valeur de la propriété jointe AutomationProperties.AccessibilityView pour l’objet DependencyObject spécifié.

SetAccessKey(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.AccessKey pour l’objet DependencyObject spécifié.

SetAutomationControlType(UIElement, AutomationControlType)

Définit la valeur de la propriété jointe AutomationProperties.AutomationControlType pour l’objet DependencyObject spécifié.

SetAutomationId(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.AutomationId pour l’objet DependencyObject spécifié.

SetCulture(DependencyObject, Int32)

Définit la valeur de la propriété jointe Culture pour l’objet DependencyObject spécifié.

SetFullDescription(DependencyObject, String)

Définit une chaîne localisée qui décrit l’apparence visuelle ou le contenu de l’objet DependencyObject spécifié.

SetHeadingLevel(DependencyObject, AutomationHeadingLevel)

Définit la valeur de la propriété AutomationProperties.HeadingLevel pour l’objet DependencyObject spécifié.

SetHelpText(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.HelpText pour l’objet DependencyObject spécifié.

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 dialogue.

SetIsPeripheral(DependencyObject, Boolean)

Définit une valeur booléenne qui indique si l’élément spécifié représente l’interface utilisateur du périphérique.

SetIsRequiredForForm(DependencyObject, Boolean)

Définit la valeur de la propriété jointe AutomationProperties.IsRequiredForForm pour l’objet DependencyObject spécifié.

SetItemStatus(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.ItemStatus pour l’objet DependencyObject spécifié.

SetItemType(DependencyObject, String)

Définit la valeur de la propriété jointe AutomationProperties.ItemType pour l’objet DependencyObject spécifié.

SetLabeledBy(DependencyObject, UIElement)

Définit la valeur de la propriété jointe AutomationProperties.LabeledBy pour l’objet DependencyObject spécifié.

SetLandmarkType(DependencyObject, AutomationLandmarkType)

Définit la valeur de la propriété jointe de type de point de repère pour l’objet DependencyObject spécifié.

SetLevel(DependencyObject, Int32)

Définit la valeur de la propriété jointe AutomationProperties.Level pour l’objet DependencyObject spécifié.

SetLiveSetting(DependencyObject, AutomationLiveSetting)

Définit la valeur de la propriété jointe AutomationProperties.LiveSetting pour l’objet DependencyObject spécifié.

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 point de repère localisé pour l’objet DependencyObject spécifié.

SetName(DependencyObject, String)

Définit la valeur de la AutomationProperties.Name propriété jointe pour l’objet DependencyObject spécifié.

SetPositionInSet(DependencyObject, Int32)

Définit la valeur de la propriété jointe AutomationProperties.PositionInSet pour l’objet DependencyObject spécifié.

SetSizeOfSet(DependencyObject, Int32)

Définit la valeur de la propriété jointe AutomationProperties.SizeOfSet pour l’objet DependencyObject spécifié.

S’applique à

Voir aussi