Windows Dev Center

FrameworkElementAutomationPeer Class

Expose les types dérivés FrameworkElement (y compris tous les contrôles) à Microsoft UI Automation.

Héritage

Object
  DependencyObject
    AutomationPeer
      FrameworkElementAutomationPeer

Syntaxe


public class FrameworkElementAutomationPeer : AutomationPeer

Attributs

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

Membres

FrameworkElementAutomationPeerClasse possède ces types de membres :

Constructeurs

FrameworkElementAutomationPeerClasse possède ces constructeurs.

ConstructeurDescription
FrameworkElementAutomationPeer Initializes a new instance of the FrameworkElementAutomationPeer class.

 

Méthodes

The FrameworkElementAutomationPeer 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)
CreatePeerForElement Creates a FrameworkElementAutomationPeer for the specified UIElement.
FromElement Returns the FrameworkElementAutomationPeer for the specified UIElement.
GetAcceleratorKey Gets the accelerator key combinations for the object that is associated with the UI Automation peer. (Hérité de AutomationPeer)
GetAcceleratorKeyCore Provides the peer's behavior when a Microsoft UI Automation client calls GetAcceleratorKey or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetAccessKey Gets the access key for the element that is associated with the automation peer. (Hérité de AutomationPeer)
GetAccessKeyCore Provides the peer's behavior when a Microsoft UI Automation client calls GetAccessKey or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
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. (Hérité de AutomationPeer)
GetAutomationControlTypeCore Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationControlType or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetAutomationId Gets the AutomationId of the element that is associated with the automation peer. (Hérité de AutomationPeer)
GetAutomationIdCore Provides the peer's behavior when a Microsoft UI Automation client calls GetAutomationId or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetBoundingRectangle Gets the Rect object that represents the screen coordinates of the element that is associated with the automation peer. (Hérité de AutomationPeer)
GetBoundingRectangleCore Provides the peer's behavior when a Microsoft UI Automation client calls GetBoundingRectangle or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetChildren Gets the collection of child elements that are represented in the UI Automation tree as immediate child elements of the automation peer. (Hérité de AutomationPeer)
GetChildrenCore Provides the peer's behavior when a Microsoft UI Automation client calls GetChildren or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetClassName Gets a name that is used with AutomationControlType, to differentiate the control that is represented by this AutomationPeer. (Hérité de AutomationPeer)
GetClassNameCore Provides the peer's behavior when a Microsoft UI Automation client calls GetClassName or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetClickablePoint Gets a point on the element that is associated with the automation peer that responds to a mouse click. (Hérité de AutomationPeer)
GetClickablePointCore Provides the peer's behavior when a Microsoft UI Automation client calls GetClickablePoint or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
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. (Hérité de AutomationPeer)
GetControlledPeersCore Gets a list of the controlled peers for the current automation peer. (Hérité de AutomationPeer)
GetHelpText Gets text that describes the functionality of the control that is associated with the automation peer. (Hérité de AutomationPeer)
GetHelpTextCore Provides the peer's behavior when a Microsoft UI Automation client calls GetHelpText or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetItemStatus Gets text that conveys the visual status of the element that is associated with this automation peer. (Hérité de AutomationPeer)
GetItemStatusCore Provides the peer's behavior when a Microsoft UI Automation client calls GetItemStatus or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetItemType Gets a string that describes what kind of item an element represents. (Hérité de AutomationPeer)
GetItemTypeCore Provides the peer's behavior when a Microsoft UI Automation client calls GetItemType or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetLabeledBy Gets the AutomationPeer for the UIElement that is targeted to the element. (Hérité de AutomationPeer)
GetLabeledByCore Provides the peer's behavior when a Microsoft UI Automation client calls GetLabeledBy or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetLiveSetting Gets the live setting notification behavior information for the object that is associated with the UI Automation peer. (Hérité de AutomationPeer)
GetLiveSettingCore Provides the peer's behavior when a Microsoft UI Automation client calls GetLiveSetting or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetLocalizedControlType Gets a localized string that represents the AutomationControlType value for the control that is associated with this automation peer. (Hérité de AutomationPeer)
GetLocalizedControlTypeCore Provides the peer's behavior when a Microsoft UI Automation client calls GetLocalizedControlType or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
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. (Hérité de AutomationPeer)
GetNameCore Provides the peer's behavior when a Microsoft UI Automation client calls GetName or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetOrientation Gets a value that indicates the explicit control orientation, if any. (Hérité de AutomationPeer)
GetOrientationCore Provides the peer's behavior when a Microsoft UI Automation client calls GetOrientation or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetParent Gets the AutomationPeer that is the parent of this AutomationPeer. (Hérité de AutomationPeer)
GetPattern Gets the control pattern that is associated with the specified PatternInterface. (Hérité de AutomationPeer)
GetPatternCore Provides the peer's behavior when a Microsoft UI Automation client calls GetPattern or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
GetPeerFromPoint Gets an AutomationPeer from the specified point. (Hérité de AutomationPeer)
GetPeerFromPointCore Provides the peer's behavior when a Microsoft UI Automation client calls GetPeerFromPoint or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
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. (Hérité de AutomationPeer)
HasKeyboardFocusCore Provides the peer's behavior when a Microsoft UI Automation client calls HasKeyboardFocus or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
InvalidatePeer Triggers recalculation of the main properties of the AutomationPeer and raises the PropertyChanged notification to the automation client if the properties have changed. (Hérité de AutomationPeer)
IsContentElement Gets a value that indicates whether the element that is associated with this automation peer contains data that is presented to the user. (Hérité de AutomationPeer)
IsContentElementCore Provides the peer's behavior when a Microsoft UI Automation client calls IsContentElement or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
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. (Hérité de AutomationPeer)
IsControlElementCore Provides the peer's behavior when a Microsoft UI Automation client calls IsControlElement or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
IsEnabled Gets a value that indicates whether the element associated with this automation peer supports interaction. (Hérité de AutomationPeer)
IsEnabledCore Provides the peer's behavior when a Microsoft UI Automation client calls IsEnabled or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
IsKeyboardFocusable Gets a value that indicates whether the element can accept keyboard focus. (Hérité de AutomationPeer)
IsKeyboardFocusableCore Provides the peer's behavior when a Microsoft UI Automation client calls IsKeyboardFocusable or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
IsOffscreen Gets a value that indicates whether an element is off the screen. (Hérité de AutomationPeer)
IsOffscreenCore Provides the peer's behavior when a Microsoft UI Automation client calls IsOffscreen or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
IsPassword Gets a value that indicates whether the element contains sensitive content. (Hérité de AutomationPeer)
IsPasswordCore Provides the peer's behavior when a Microsoft UI Automation client calls IsPassword or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
IsRequiredForForm Gets a value that indicates whether the element that is associated with this peer must be completed on a form. (Hérité de AutomationPeer)
IsRequiredForFormCore Provides the peer's behavior when a Microsoft UI Automation client calls IsRequiredForForm or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
PeerFromProvider Gets an AutomationPeer for the specified IRawElementProviderSimple proxy. (Hérité de AutomationPeer)
ProviderFromPeer Gets the IRawElementProviderSimple proxy for the specified AutomationPeer. (Hérité de AutomationPeer)
RaiseAutomationEvent Raises an automation event. (Hérité de AutomationPeer)
RaisePropertyChangedEvent Raises an event to notify the automation client of a changed property value. (Hérité de AutomationPeer)
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. (Hérité de AutomationPeer)
SetFocusCore Provides the peer's behavior when a Microsoft UI Automation client calls SetFocus or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)
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. (Hérité de AutomationPeer)
ShowContextMenuCore Provides the peer's behavior when a Microsoft UI Automation client calls ShowContextMenu or an equivalent Microsoft UI Automation client API. (Hérité de AutomationPeer)

 

Propriétés

Le FrameworkElementAutomationPeerClasse 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. (Hérité de AutomationPeer)

Owner

En lecture seuleGets the UIElement owner that is associated with this FrameworkElementAutomationPeer.

 

Remarques

Il n'existe aucune classe "ControlAutomationPeer". FrameworkElementAutomationPeer sert d'implémentation à tous les scénarios de base de la classe Control qui impliquent UI Automation. Cela inclut le comportement qui n'apparaît pas nécessairement comme une exposition d'API publique, tel que les implémentations pratiques de nombreuses méthodes Core d'AutomationPeer.

FrameworkElementAutomationPeer inclut l'implémentation de base étendue du comportement homologue que d'autres homologues peuvent utiliser pour signaler des informations provenant des classes propriétaires au niveau de UIElement et FrameworkElement. Pour plus d'informations, consultez la section « Implémentation de base dans FrameworkElementAutomationPeer » de la rubrique Homologues Automation personnalisés.

Outre les substitutions Core, FrameworkElementAutomationPeer a deux méthodes d'utilitaire statiques qui sont utiles en vue d'obtenir un handle homologue à partir du code de contrôle ou de générer des homologues d'éléments d'un homologue de conteneur d'éléments pour la prise en charge d'UI Automation. Il s'agit des valeurs suivantes :

Si vous devez définir un homologue Automation personnalisé et que vous ne pouvez pas identifier une classe homologue plus dérivée qui forme une paire avec la classe de contrôle ou de base à partir de laquelle vous dérivez la classe propriétaire, vous devez baser votre homologue sur FrameworkElementAutomationPeer. Même si la classe propriétaire n'est pas nécessairement FrameworkElement, vous ne pouvez pratiquement pas effectuer une dérivation directe des homologues à partir de AutomationPeer car FrameworkElementAutomationPeer possède de nombreuses substitutions qui fournissent le comportement attendu pour la disposition, l'automation et les interactions de l'interface utilisateur. Vous devez au moins dériver votre classe propriétaire d'UIElement, sinon il n'existe aucun moyen de créer l'homologue sur le chargement de l'arborescence Automation avec OnCreateAutomationPeer.

Exemples

Cet exemple indique les spécifications fondamentales des sous-classes pour dériver un homologue d'un FrameworkElementAutomationPeer et prendre en charge au moins un modèle de contrôle. Ce code est issu de l'exemple d'accessibilité XAML.


        public class MediaContainerAP : FrameworkElementAutomationPeer, IRangeValueProvider, IToggleProvider
        {
            MediaElement _mediaElement;
            FrameworkElement _labeledBy;
// nondefault ctors omitted
            protected override object GetPatternCore(PatternInterface patternInterface)
            {
                if (patternInterface == PatternInterface.RangeValue)
                {
                    return this;
                }
                else if (patternInterface == PatternInterface.Toggle)
                {
                    return this;
                }
                return null;
            }


            protected override AutomationControlType GetAutomationControlTypeCore()
            {
                return AutomationControlType.Group;
            }

            protected override string GetLocalizedControlTypeCore()
            {
                return "Video";
            }

            protected override string GetClassNameCore()
            {
                return "MediaElementContainer";
            }
// pattern implementation omitted ...
        }


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

FrameworkElement
Homologues Automation personnalisés
AutomationPeer
Exemple d'accessibilité XAML

 

 

Afficher:
© 2015 Microsoft