Windows Dev Center

Développer Réduire

AutomationPeer Class

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

Héritage

Object
  DependencyObject
    AutomationPeer

Syntaxe


public class AutomationPeer : DependencyObject

Attributs

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

Membres

AutomationPeerClasse possède ces types de membres :

Constructeurs

AutomationPeerClasse possède ces constructeurs.

ConstructeurDescription
AutomationPeer Provides base class initialization behavior for AutomationPeer derived classes.

 

Méthodes

The AutomationPeer Classe a les méthodes suivantes. Elle hérite également des méthodes de Object Classe.

MéthodeDescription
ClearValue Clears the local value of a dependency property. (Hérité de DependencyObject)
GetAcceleratorKey Gets the accelerator key combinations for the object that is associated with the UI Automation peer.
GetAcceleratorKeyCore Provides the peer's behavior when a Microsoft UI Automation client calls GetAcceleratorKey or an equivalent Microsoft UI Automation client API.
GetAccessKey Gets the access key for the element that is associated with the automation peer.
GetAccessKeyCore Provides the peer's behavior when a Microsoft UI Automation client calls GetAccessKey or an equivalent Microsoft UI Automation client API.
GetAnimationBaseValue Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Hérité de DependencyObject)
GetAutomationControlType Gets the control type for the element that is associated with the UI Automation peer.
GetAutomationControlTypeCore Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationControlType or an equivalent Microsoft UI Automation client API.
GetAutomationId Gets the AutomationId of the element that is associated with the automation peer.
GetAutomationIdCore Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationId or an equivalent Microsoft UI Automation client API.
GetBoundingRectangle Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer.
GetBoundingRectangleCore Provides the peer's behavior when a Microsoft UI Automation client calls GetBoundingRectangle or an equivalent Microsoft UI Automation client API.
GetChildren Gets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer.
GetChildrenCore Provides the peer's behavior when a Microsoft UI Automation client calls GetChildren or an equivalent Microsoft UI Automation client API.
GetClassName Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer.
GetClassNameCore Provides the peer's behavior when a Microsoft UI Automation client calls GetClassName or an equivalent Microsoft UI Automation client API.
GetClickablePoint Gets a point on the element that is associated with the automation peer that responds to a mouse click.
GetClickablePointCore Provides the peer's behavior when a Microsoft UI Automation client calls GetClickablePoint or an equivalent Microsoft UI Automation client API.
GetControlledPeers Provides the peer's behavior when a Microsoft UI Automation client calls GetControlledPeers or an equivalent Microsoft UI Automation client API such as getting a property value as identified by UIA_ControllerForPropertyId.
GetControlledPeersCore Gets a list of the controlled peers for the current automation peer.
GetHelpText Gets text that describes the functionality of the control that is associated with the automation peer.
GetHelpTextCore Provides the peer's behavior when a Microsoft UI Automation client calls GetHelpText or an equivalent Microsoft UI Automation client API.
GetItemStatus Gets text that conveys the visual status of the element that is associated with this automation peer.
GetItemStatusCore Provides the peer's behavior when a Microsoft UI Automation client calls GetItemStatus or an equivalent Microsoft UI Automation client API.
GetItemType Gets a string that describes what kind of item an element represents.
GetItemTypeCore Provides the peer's behavior when a Microsoft UI Automation client calls GetItemType or an equivalent Microsoft UI Automation client API.
GetLabeledBy Gets the AutomationPeer for the UIElement that is targeted to the element.
GetLabeledByCore Provides the peer's behavior when a Microsoft UI Automation client calls GetLabeledBy or an equivalent Microsoft UI Automation client API.
GetLiveSetting Gets the live setting notification behavior information for the object that is associated with the UI Automation peer.
GetLiveSettingCore Provides the peer's behavior when a Microsoft UI Automation client calls GetLiveSetting or an equivalent Microsoft UI Automation client API.
GetLocalizedControlType Gets a localized string that represents the AutomationControlType value for the control that is associated with this automation peer.
GetLocalizedControlTypeCore Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedControlType or an equivalent Microsoft UI Automation client API.
GetName Gets text that describes the element that is associated with this automation peer. The Microsoft UI Automation Name value is the primary identifier used by most assistive technology when they represent your app's UI by interacting with the Microsoft UI Automation framework.
GetNameCore Provides the peer's behavior when a Microsoft UI Automation client calls GetName or an equivalent Microsoft UI Automation client API.
GetOrientation Gets a value that indicates the explicit control orientation, if any.
GetOrientationCore Provides the peer's behavior when a Microsoft UI Automation client calls GetOrientation or an equivalent Microsoft UI Automation client API.
GetParent Gets the AutomationPeer that is the parent of this AutomationPeer.
GetPattern Gets the control pattern that is associated with the specified PatternInterface.
GetPatternCore Provides the peer's behavior when a Microsoft UI Automation client calls GetPattern or an equivalent Microsoft UI Automation client API.
GetPeerFromPoint Gets an AutomationPeer from the specified point.
GetPeerFromPointCore Provides the peer's behavior when a Microsoft UI Automation client calls GetPeerFromPoint or an equivalent Microsoft UI Automation client API.
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Hérité de DependencyObject)
HasKeyboardFocus Gets a value that indicates whether the element that is associated with this automation peer currently has keyboard focus.
HasKeyboardFocusCore Provides the peer's behavior when a Microsoft UI Automation client calls HasKeyboardFocus or an equivalent Microsoft UI Automation client API.
InvalidatePeer Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the automation client if the properties have changed.
IsContentElement Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user.
IsContentElementCore Provides the peer's behavior when a Microsoft UI Automation client calls IsContentElement or an equivalent Microsoft UI Automation client API.
IsControlElement Gets a value that indicates whether the element is understood by the user as interactive or as contributing to the logical structure of the control in the GUI.
IsControlElementCore Provides the peer's behavior when a Microsoft UI Automation client calls IsControlElement or an equivalent Microsoft UI Automation client API.
IsEnabled Gets a value that indicates whether the element associated with this automation peer supports interaction.
IsEnabledCore Provides the peer's behavior when a Microsoft UI Automation client calls IsEnabled or an equivalent Microsoft UI Automation client API.
IsKeyboardFocusable Gets a value that indicates whether the element can accept keyboard focus.
IsKeyboardFocusableCore Provides the peer's behavior when a Microsoft UI Automation client calls IsKeyboardFocusable or an equivalent Microsoft UI Automation client API.
IsOffscreen Gets a value that indicates whether an element is off the screen.
IsOffscreenCore Provides the peer's behavior when a Microsoft UI Automation client calls IsOffscreen or an equivalent Microsoft UI Automation client API.
IsPassword Gets a value that indicates whether the element contains sensitive content.
IsPasswordCore Provides the peer's behavior when a Microsoft UI Automation client calls IsPassword or an equivalent Microsoft UI Automation client API.
IsRequiredForForm Gets a value that indicates whether the element that is associated with this peer must be completed on a form.
IsRequiredForFormCore Provides the peer's behavior when a Microsoft UI Automation client calls IsRequiredForForm or an equivalent Microsoft UI Automation client API.
ListenerExists Gets a value that indicates whether Microsoft UI Automation reports that a client is listening for the specified event.
PeerFromProvider Gets an AutomationPeer for the specified IRawElementProviderSimple proxy.
ProviderFromPeer Gets the IRawElementProviderSimple proxy for the specified AutomationPeer.
RaiseAutomationEvent Raises an automation event.
RaisePropertyChangedEvent Raises an event to notify the automation client of a changed property value.
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Hérité de DependencyObject)
SetFocus Sets the keyboard focus on the element that is associated with this automation peer.
SetFocusCore Provides the peer's behavior when a Microsoft UI Automation client calls SetFocus or an equivalent Microsoft UI Automation client API.
SetValue Sets the local value of a dependency property on a DependencyObject. (Hérité de DependencyObject)
ShowContextMenu Shows the available context menu for the owner element.
ShowContextMenuCore Provides the peer's behavior when a Microsoft UI Automation client calls ShowContextMenu or an equivalent Microsoft UI Automation client API.

 

Propriétés

Le AutomationPeerClasse a les propriétés suivantes.

PropriétéType d'accèsDescription

Dispatcher

En lecture seuleGets the CoreDispatcher that this object is associated with. (Hérité de DependencyObject)

EventsSource

Lecture/écritureGets or sets an AutomationPeer that is reported to the automation client as the source for all the events that come from this AutomationPeer. See Remarks.

 

Remarques

AutomationPeer est la classe qui fournit quasiment toutes les API en charge du transfert des informations UI Automation pour une application Windows Store en C++, C# ou Visual Basic, à un client UI Automation. Les clients UI Automation classiques n'appellent pas de méthodes AutomationPeer directement. Ces clients sont souvent des technologies d'assistance qui utilisent d'autres modèles de programmation et fonctionnent comme des services, et ne sont pas susceptibles d'être appelés par les méthodes Windows Runtime. Cependant, la prise en charge de UI Automation dans le Windows Runtime transfère toutes ces informations en tant que fournisseur, pour que tous les clients de UI Automation puissent interagir avec les arborescences Automation représentatives d'une application du Windows Store utilisant C++ ou C# ou Visual Basic.

Déclenchement d'événements automation

La classe AutomationPeer est pertinente pour les auteurs de contrôles Windows Runtime, car une instance homologue sera disponible au moment de l'exécution, après l'appel de la méthode OnCreateAutomationPeer par le runtime. À l'aide de l'homologue, vous pouvez déclencher des événements Automation en appelant RaiseAutomationEvent et RaisePropertyChangedEvent. Pour cela, chaque fois qu'une propriété connexe du propriétaire de l'homologue (votre classe) est modifiée ou lorsque le déclenchement d'un événement est requis pour la prise en charge correcte de l'automation.

La conception de la prise en charge de l'automation ne conserve pas un handle de votre propre homologue dans le cadre de la procédure d'implémentation de OnCreateAutomationPeer, car il n'existe aucune garantie du moment où l'homologue est réellement créé. À la place, recherchez les écouteurs d'événements Automation d'exécution dans vos définitions de classe de contrôle juste-à-temps, à l'aide de 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);
    }
}


Conditions requises

Client minimal pris en charge

Windows 8 [Applications Windows Store uniquement]

Serveur minimal pris en charge

Windows Server 2012 [Applications Windows Store uniquement]

Espace de noms

Windows.UI.Xaml.Automation.Peers
Windows::UI::Xaml::Automation::Peers [C++]

Métadonnées

Windows.winmd

Voir aussi

DependencyObject
Homologues Automation personnalisés
Exemple d'accessibilité XAML

 

 

Afficher:
© 2015 Microsoft