AutomationPeer Classe

  • Référence

Définition

Espace de noms:
Windows.UI.Xaml.Automation.Peers
Modifier

Fournit une classe de base qui expose l’homologue Automation pour une classe propriétaire associée à Microsoft UI Automation.

public ref class AutomationPeer : DependencyObject
/// [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 AutomationPeer : DependencyObject
[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 class AutomationPeer : DependencyObject
Public Class AutomationPeer
Inherits DependencyObject
Héritage
Object Platform::Object IInspectable DependencyObject AutomationPeer
Dérivé
Attributs
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Configuration requise pour Windows

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

Remarques

AutomationPeer est la classe qui fournit la quasi-totalité de l’API qui transfère les informations Microsoft UI Automation pour une application UWP à l’aide de C++, C# ou Visual Basic vers un client Microsoft UI Automation. Les clients Microsoft UI Automation classiques n’appellent pas directement les méthodes AutomationPeer. Ces clients sont souvent des technologies d’assistance qui utilisent d’autres modèles de programmation et fonctionnent comme des services, et qui ne sont pas susceptibles d’appeler Windows Runtime méthodes. Toutefois, la prise en charge générale de Microsoft UI Automation dans le Windows Runtime transfère toutes ces informations à l’aide du côté fournisseur de l’infrastructure Microsoft UI Automation. Tous les clients de Microsoft UI Automation peuvent interagir avec les arborescences d’automatisation représentatives d’une application UWP en C++, C# ou Visual Basic.

Déclenchement d’événements d’automatisation

La classe AutomationPeer est pertinente pour Windows Runtime auteurs de contrôles, car vous aurez un homologue instance disponible au moment de l’exécution, une fois que le runtime aura appelé la méthode OnCreateAutomationPeer. À l’aide de cet homologue, vous pouvez déclencher des événements d’automatisation en appelant RaiseAutomationEvent et RaisePropertyChangedEvent. Vous le faites chaque fois qu’une propriété associée dans le propriétaire de l’homologue (votre classe) change, ou quand le déclenchement d’un événement est nécessaire pour une prise en charge correcte de l’automatisation.

La conception de prise en charge de l’automatisation ne conserve pas de handle pour votre propre homologue dans le cadre de la façon dont vous implémentez OnCreateAutomationPeer, car il n’existe aucune garantie quant au moment où l’homologue est réellement créé. Au lieu de cela, vous pouvez case activée pour les écouteurs d’événements d’automatisation au moment de l’exécution à l’intérieur de vos définitions de classe de contrôle juste-à-temps, en utilisant du code comme suit :

if (AutomationPeer.ListenerExists(AutomationEvents.PropertyChanged))
{
    MyAutomationPeer peer = 
        FrameworkElementAutomationPeer.FromElement(myCtrl) as MyAutomationPeer;

    if (peer != null)
    {
        peer.RaisePropertyChangedEvent(
            RangeValuePatternIdentifiers.ValueProperty,
            (double)oldValue,
            (double)newValue);
    }
}

If AutomationPeer.ListenerExists(AutomationEvents.PropertyChanged) Then
    Dim peer As MyAutomationPeer = _
    TryCast(FrameworkElementAutomationPeer.FromElement(myCtrl), MyAutomationPeer)
    If peer IsNot Nothing Then
        peer.RaisePropertyChangedEvent(RangeValuePatternIdentifiers.ValueProperty, CDbl(oldValue), CDbl(newValue))
    End If
End If

Classes dérivées AutomationPeer

AutomationPeer se trouve dans la hiérarchie pour tous les homologues existants pour les contrôles Windows Runtime et les classes d’interface utilisateur associées.

Les classes qui dérivent directement d’AutomationPeer sont les suivantes :

Méthodes principales

Les méthodes « Core » sont les implémentations standard qui effectuent l’action par défaut d’une méthode pouvant être appelée par le client Microsoft UI Automation associée. Vous pouvez remplacer n’importe quelle méthode « Core » pour retourner d’autres valeurs dans un homologue Automation personnalisé. Par exemple, GetAcceleratorKeyCore est appelé chaque fois que GetAcceleratorKey est appelé, GetAccessKeyCore est appelé chaque fois que GetAccessKey est appelé, et ainsi de suite.

L’implémentation de base pour AutomationPeer retourne null. Les pairs qui représentent des éléments peuvent différer le résultat à leur conteneur.

Historique des versions

Version de Windows Version du SDK Valeur ajoutée
1511 10586 GetLandmarkType
1511 10586 GetLandmarkTypeCore
1511 10586 GetLocalizedLandmarkType
1511 10586 GetLocalizedLandmarkTypeCore
1607 14393 GetDescribedByCore
1607 14393 GetFlowsFromCore
1607 14393 GetFlowsToCore
1607 14393 GetFullDescription
1607 14393 GetFullDescriptionCore
1607 14393 IsDataValidForForm
1607 14393 IsDataValidForFormCore
1607 14393 IsPeripheral
1607 14393 IsPeripheralCore
1703 15063 GetCulture
1703 15063 GetCultureCore
1709 16299 RaiseNotificationEvent
1803 17134 GetHeadingLevel
1803 17134 GetHeadingLevelCore
1809 17763 IsDialog
1809 17763 IsDialogCore

Constructeurs

AutomationPeer()

Fournit le comportement d’initialisation de classe de base pour les classes dérivées AutomationPeer .

Propriétés

Dispatcher

Obtient le CoreDispatcher auquel cet objet est associé. CoreDispatcher représente une fonctionnalité qui peut accéder à DependencyObject sur le thread d’interface utilisateur, même si le code est initié par un thread autre que l’interface utilisateur.

(Hérité de DependencyObject)
EventsSource

Obtient ou définit un AutomationPeer qui est signalé au client Automation en tant que source pour tous les événements qui proviennent de cet AutomationPeer. Consultez la section Notes.

Méthodes

ClearValue(DependencyProperty)

Efface la valeur locale d’une propriété de dépendance.

(Hérité de DependencyObject)
GenerateRawElementProviderRuntimeId()

Génère un identificateur d’exécution pour l’élément associé à l’homologue Automation.
GetAcceleratorKey()

Obtient les combinaisons de touches d’accélérateur pour l’objet associé à l’homologue UI Automation.
GetAcceleratorKeyCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetAcceleratorKey ou une API cliente Microsoft UI Automation équivalente.
GetAccessKey()

Obtient la clé d’accès pour l’élément associé à l’homologue automation.
GetAccessKeyCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetAccessKey ou une API cliente Microsoft UI Automation équivalente.
GetAnimationBaseValue(DependencyProperty)

Retourne toute valeur de base établie pour une propriété de dépendance, qui s’appliquerait dans les cas où une animation n’est pas active.

(Hérité de DependencyObject)
GetAnnotations()

Obtient une référence à la liste des annotations d’automatisation de l’interface utilisateur pour l’homologue Automation actuel.
GetAnnotationsCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetAnnotations ou une API cliente Microsoft UI Automation équivalente.
GetAutomationControlType()

Obtient le type de contrôle de l’élément associé à l’homologue UI Automation.
GetAutomationControlTypeCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetAutomationControlType ou une API cliente Microsoft UI Automation équivalente.
GetAutomationId()

Obtient l’AutomationId de l’élément associé à l’homologue Automation.
GetAutomationIdCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetAutomationId ou une API cliente Microsoft UI Automation équivalente.
GetBoundingRectangle()

Obtient l’objet Rect qui représente les coordonnées d’écran de l’élément associé à l’homologue Automation.
GetBoundingRectangleCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetBoundingRectangle ou une API cliente Microsoft UI Automation équivalente.
GetChildren()

Obtient la collection d’éléments enfants qui sont représentés dans l’arborescence UI Automation en tant qu’éléments enfants immédiats de l’homologue Automation.
GetChildrenCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetChildren ou une API cliente Microsoft UI Automation équivalente.
GetClassName()

Obtient un nom utilisé avec AutomationControlType pour différencier le contrôle représenté par cet AutomationPeer.
GetClassNameCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetClassName ou une API cliente Microsoft UI Automation équivalente.
GetClickablePoint()

Obtient un point sur l’élément associé à l’homologue Automation qui répond à un clic de souris.
GetClickablePointCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetClickablePoint ou une API cliente Microsoft UI Automation équivalente.
GetControlledPeers()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetControlPeers ou une API cliente Microsoft UI Automation équivalente, comme l’obtention d’une valeur de propriété identifiée par UIA_ControllerForPropertyId.
GetControlledPeersCore()

Obtient la liste des homologues contrôlés pour l’homologue Automation actuel.
GetCulture()

Appelle GetCultureCore pour obtenir la valeur de culture de l’élément associé à l’homologue Automation.
GetCultureCore()

Obtient la valeur de culture de l’élément associé à l’homologue Automation.
GetDescribedByCore()

Obtient une collection d’éléments qui fournissent plus d’informations sur l’élément automation.
GetElementFromPoint(Point)

Obtient un élément à partir du point spécifié.
GetElementFromPointCore(Point)

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetElementFromPoint ou une API cliente Microsoft UI Automation équivalente.
GetFlowsFromCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetFlowsFrom ou une API cliente Microsoft UI Automation équivalente.
GetFlowsToCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetFlowsTo ou une API cliente Microsoft UI Automation équivalente.
GetFocusedElement()

Obtient l’élément qui a actuellement le focus.
GetFocusedElementCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetFocusedElement ou une API cliente Microsoft UI Automation équivalente.
GetFullDescription()

Obtient une chaîne localisée qui décrit l’apparence visuelle réelle ou le contenu d’un élément tel qu’une image ou un contrôle d’image.
GetFullDescriptionCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetFullDescription ou une API cliente Microsoft UI Automation équivalente.
GetHeadingLevel()

Obtient le niveau de titre de l’élément UI Automation associé à cet homologue Automation.
GetHeadingLevelCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetHeadingLevel ou une API cliente Microsoft UI Automation équivalente.
GetHelpText()

Obtient le texte qui décrit les fonctionnalités du contrôle associé à l'homologue Automation.
GetHelpTextCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetHelpText ou une API cliente Microsoft UI Automation équivalente.
GetItemStatus()

Obtient le texte qui communique l'état visuel de l'élément associé à cet homologue Automation.
GetItemStatusCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetItemStatus ou une API cliente Microsoft UI Automation équivalente.
GetItemType()

Obtient une chaîne qui décrit le type d’élément qu’un élément représente.
GetItemTypeCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetItemType ou une API cliente Microsoft UI Automation équivalente.
GetLabeledBy()

Obtient l’AutomationPeer pour l’élément UIElement qui est ciblé sur l’élément.
GetLabeledByCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetLabeledBy ou une API cliente Microsoft UI Automation équivalente.
GetLandmarkType()

Obtient le type de point de repère pour cet homologue Automation.
GetLandmarkTypeCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetLandmarkType ou une API cliente Microsoft UI Automation équivalente.
GetLevel()

Retourne l’entier de base 1 pour le niveau (hiérarchie) de l’élément associé à l’homologue Automation.
GetLevelCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetLevel ou une API cliente Microsoft UI Automation équivalente.
GetLiveSetting()

Obtient les informations de comportement de notification de paramètre en direct pour l’objet associé à l’homologue UI Automation.
GetLiveSettingCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetLiveSetting ou une API cliente Microsoft UI Automation équivalente.
GetLocalizedControlType()

Obtient une chaîne localisée qui représente la valeur AutomationControlType du contrôle associé à cet homologue Automation.
GetLocalizedControlTypeCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetLocalizedControlType ou une API cliente Microsoft UI Automation équivalente.
GetLocalizedLandmarkType()

Obtient une chaîne localisée qui représente la valeur AutomationLandmarkType de l’élément associé à cet homologue Automation.
GetLocalizedLandmarkTypeCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetLocalizedLandmarkType ou une API cliente Microsoft UI Automation équivalente.
GetName()

Obtient le texte qui décrit l'élément associé à cet homologue Automation. La valeur Nom de Microsoft UI Automation est l’identificateur principal utilisé par la plupart des technologies d’assistance lorsqu’elles représentent l’interface utilisateur de votre application en interagissant avec l’infrastructure Microsoft UI Automation.
GetNameCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetName ou une API cliente Microsoft UI Automation équivalente.
GetOrientation()

Obtient une valeur qui indique l'orientation de contrôle explicite, le cas échéant.
GetOrientationCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetOrientation ou une API cliente Microsoft UI Automation équivalente.
GetParent()

Obtient l’AutomationPeer qui est le parent de cet AutomationPeer.
GetPattern(PatternInterface)

Obtient le modèle de contrôle associé au patternInterface spécifié.
GetPatternCore(PatternInterface)

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetPattern ou une API cliente Microsoft UI Automation équivalente.
GetPeerFromPoint(Point)

Obtient un AutomationPeer à partir du point spécifié.
GetPeerFromPointCore(Point)

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetPeerFromPoint ou une API cliente Microsoft UI Automation équivalente.
GetPositionInSet()

Retourne l’entier de base 1 pour la position ordinale dans le jeu pour l’élément associé à l’homologue Automation.
GetPositionInSetCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetPositionInSet ou une API cliente Microsoft UI Automation équivalente.
GetSizeOfSet()

Retourne l’entier de base 1 pour la taille du jeu où se trouve l’élément associé à l’homologue Automation.
GetSizeOfSetCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle GetSizeOfSet ou une API cliente Microsoft UI Automation équivalente.
GetValue(DependencyProperty)

Retourne la valeur effective actuelle d’une propriété de dépendance à partir d’un DependencyObject.

(Hérité de DependencyObject)
HasKeyboardFocus()

Obtient une valeur qui indique si l'élément associé à cet homologue Automation a actuellement le focus clavier.
HasKeyboardFocusCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle HasKeyboardFocus ou une API cliente Microsoft UI Automation équivalente.
InvalidatePeer()

Déclenche le recalcul des propriétés main d’AutomationPeer et déclenche la notification PropertyChanged au client Automation si les propriétés ont changé.
IsContentElement()

Obtient une valeur qui indique si l’élément associé à cet homologue Automation contient des données qui sont présentées à l’utilisateur.
IsContentElementCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle IsContentElement ou une API cliente Microsoft UI Automation équivalente.
IsControlElement()

Obtient une valeur qui indique si l’élément est compris par l’utilisateur comme interactif ou comme contribuant à la structure logique du contrôle dans l’interface graphique graphique.
IsControlElementCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle IsControlElement ou une API cliente Microsoft UI Automation équivalente.
IsDataValidForForm()

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 automation.
IsDataValidForFormCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation accède à IsDataValidForForm ou à une API cliente Microsoft UI Automation équivalente.
IsDialog()

Obtient une valeur qui indique si l’élément associé à cet homologue Automation est une fenêtre de dialogue.
IsDialogCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle IsDialog ou une API cliente Microsoft UI Automation équivalente.
IsEnabled()

Obtient une valeur qui indique si l'élément associé à cet homologue Automation prend en charge l'interaction.
IsEnabledCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle IsEnabled ou une API cliente Microsoft UI Automation équivalente.
IsKeyboardFocusable()

Obtient une valeur qui indique si l'élément peut accepter le focus clavier.
IsKeyboardFocusableCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle IsKeyboardFocusable ou une API cliente Microsoft UI Automation équivalente.
IsOffscreen()

Obtient une valeur qui indique si un élément est en dehors de l'écran.
IsOffscreenCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle IsOffscreen ou une API cliente Microsoft UI Automation équivalente.
IsPassword()

Obtient une valeur qui indique si l'élément spécifié contient du contenu sensible.
IsPasswordCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle IsPassword ou une API cliente Microsoft UI Automation équivalente.
IsPeripheral()

Obtient une valeur booléenne qui indique si l’élément automation représente l’interface utilisateur périphérique.
IsPeripheralCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation accède à IsPeripheral ou à une API cliente Microsoft UI Automation équivalente.
IsRequiredForForm()

Obtient une valeur qui indique si l'élément associé à cet homologue doit être renseigné dans un formulaire.
IsRequiredForFormCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle IsRequiredForForm ou une API cliente Microsoft UI Automation équivalente.
ListenerExists(AutomationEvents)

Obtient une valeur qui indique si Microsoft UI Automation signale qu’un client écoute l’événement spécifié.
Navigate(AutomationNavigationDirection)

Obtient l’élément dans la direction spécifiée dans l’arborescence UI Automation.
NavigateCore(AutomationNavigationDirection)

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle Navigate ou une API cliente Microsoft UI Automation équivalente.
PeerFromProvider(IRawElementProviderSimple)

Obtient un AutomationPeer pour le proxy IRawElementProviderSimple spécifié.
ProviderFromPeer(AutomationPeer)

Obtient le proxy IRawElementProviderSimple pour l’AutomationPeer spécifié.
RaiseAutomationEvent(AutomationEvents)

Déclenche un événement Automation.
RaiseNotificationEvent(AutomationNotificationKind, AutomationNotificationProcessing, String, String)

Lance un événement de notification.
RaisePropertyChangedEvent(AutomationProperty, Object, Object)

Déclenche un événement pour signaler au client Automation qu’une valeur de propriété a changé.
RaiseStructureChangedEvent(AutomationStructureChangeType, AutomationPeer)

Déclenche un événement pour informer le noyau Microsoft UI Automation que l’arborescence a changé.
RaiseTextEditTextChangedEvent(AutomationTextEditChangeType, IVectorView<String>)

Déclenche un événement pour informer le noyau Microsoft UI Automation qu’un contrôle de texte a modifié le texte par programmation.
ReadLocalValue(DependencyProperty)

Retourne la valeur locale d’une propriété de dépendance, si une valeur locale est définie.

(Hérité de DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Inscrit une fonction de notification pour écouter les modifications apportées à un DependencyProperty spécifique sur ce instance DependencyObject.

(Hérité de DependencyObject)
SetFocus()

Définit le focus clavier sur l'élément qui est associé à cet homologue Automation.
SetFocusCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle SetFocus ou une API cliente Microsoft UI Automation équivalente.
SetParent(AutomationPeer)

Définit l’AutomationPeer qui est le parent de cet AutomationPeer.
SetValue(DependencyProperty, Object)

Définit la valeur locale d’une propriété de dépendance sur un DependencyObject.

(Hérité de DependencyObject)
ShowContextMenu()

Affiche le menu contextuel disponible pour l’élément owner.
ShowContextMenuCore()

Fournit le comportement de l’homologue lorsqu’un client Microsoft UI Automation appelle ShowContextMenu ou une API cliente Microsoft UI Automation équivalente.
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Annule une notification de modification précédemment inscrite en appelant RegisterPropertyChangedCallback.

(Hérité de DependencyObject)

S’applique à

Voir aussi