FrameworkElementAutomationPeer Classe

Référence

Définition

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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Modifier

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

/// [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 FrameworkElementAutomationPeer : AutomationPeer

[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 class FrameworkElementAutomationPeer : AutomationPeer

Public Class FrameworkElementAutomationPeer
Inherits AutomationPeer

Héritage: Object IInspectable DependencyObject AutomationPeer FrameworkElementAutomationPeer

Dérivé: Microsoft.UI.Xaml.Automation.Peers.AnimatedVisualPlayerAutomationPeer

Microsoft.UI.Xaml.Automation.Peers.AppBarAutomationPeer

Microsoft.UI.Xaml.Automation.Peers.AutoSuggestBoxAutomationPeer

Microsoft.UI.Xaml.Automation.Peers.BreadcrumbBarItemAutomationPeer

Microsoft.UI.Xaml.Automation.Peers.ButtonBaseAutomationPeer

Plus…

Attributs: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Exemples

Cet exemple montre les exigences de sous-classe de base pour dériver un homologue à partir de FrameworkElementAutomationPeer et prendre en charge au moins un modèle de contrôle.

Ce code est un extrait de l’exemple d’accessibilité XAML .

Note

Cet exemple n’est pas conservé et peut ne pas être compilé.

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

Fichiers MIDL 3.0 pour l’exemple de code C++/WinRT qui suit.

// MediaElementContainer.idl
namespace MyNamespace
{
    runtimeclass MediaElementContainer : Windows.UI.Xaml.Controls.ContentControl
    {
        MediaElementContainer(Windows.UI.Xaml.Controls.Panel parent);
        ...
    };
}

// MediaContainerAP.idl
import "MediaElementContainer.idl";

namespace MyNamespace
{
    runtimeclass MediaContainerAP : Windows.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer,
        Windows.UI.Xaml.Automation.Provider.IRangeValueProvider,
        Windows.UI.Xaml.Automation.Provider.IToggleProvider
    {
        MediaContainerAP(MediaElementContainer owner, Windows.UI.Xaml.Controls.MediaElement mediaElement);
        ...
    };
}

// MediaContainerAP.h
struct MediaContainerAP : MediaContainerAPT<MediaContainerAP>
{
    MediaContainerAP() = delete;
	// Non-default ctors omitted.

    Windows::Foundation::IInspectable GetPatternCore(Windows::UI::Xaml::Automation::Peers::PatternInterface const& patternInterface)
    {
        if (patternInterface == Windows::UI::Xaml::Automation::Peers::PatternInterface::RangeValue)
        {
            return *this;
        }
        else if (patternInterface == Windows::UI::Xaml::Automation::Peers::PatternInterface::Toggle)
        {
            return *this;
        }
        return nullptr;
    }

    Windows::UI::Xaml::Automation::Peers::AutomationControlType GetAutomationControlTypeCore()
    {
        return Windows::UI::Xaml::Automation::Peers::AutomationControlType::Group;
    }

    winrt::hstring GetLocalizedControlTypeCore()
    {
        return L"Video";
    }

    winrt::hstring GetClassNameCore()
    {
        return L"MediaElementContainer";
    }

	// Pattern implementation omitted.
};

// header
        public ref class MediaContainerAP sealed :  Windows::UI::Xaml::Automation::Peers::FrameworkElementAutomationPeer
                                                    ,Windows::UI::Xaml::Automation::Provider::IRangeValueProvider
                                                    ,Windows::UI::Xaml::Automation::Provider::IToggleProvider
        {
// nondefault ctors omitted
        protected: 
            virtual Object^ GetPatternCore(PatternInterface patternInterface) override
            {
                if (patternInterface == PatternInterface::RangeValue)
                {
                    return this;
                }
                else if (patternInterface == PatternInterface::Toggle)
                {
                    return this;
                }
                return nullptr;
            }

        protected:
            virtual  AutomationControlType GetAutomationControlTypeCore() override
            {
                return  AutomationControlType::Group;
            }

        protected:
            virtual Platform::String^ GetLocalizedControlTypeCore() override
            {
                return "Video";
            }

        protected:
            virtual Platform::String^ GetClassNameCore() override
            {
                return "MediaElementContainer";
            }
// pattern implementation omitted

Remarques

Il n’existe aucune classe « ControlAutomationPeer ». FrameworkElementAutomationPeer sert d’implémentation pour tous les scénarios de classe de base Control qui impliquent Microsoft UI Automation. Cela inclut le comportement qui n’apparaît pas nécessairement comme une exposition à l’API publique, comme les implémentations pratiques de la plupart des méthodes Core de AutomationPeer.

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

En plus des remplacements de Core, FrameworkElementAutomationPeer a deux méthodes utilitaires statiques qui sont utiles pour obtenir un handle homologue à partir du code de contrôle ou pour générer des homologues d’éléments à partir d’un homologue de conteneur d’éléments pour la prise en charge de Microsoft UI Automation. Voici les éléments suivants :

CreatePeerForElement
FromElement

Si vous avez besoin de définir un homologue Automation personnalisé et que vous ne pouvez pas identifier une classe homologue plus dérivée qui s’associe au contrôle ou à la classe 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 un FrameworkElement, vous ne pouvez pas dériver pratiquement des homologues de AutomationPeer directement, car FrameworkElementAutomationPeer a de nombreux remplacements qui fournissent le comportement attendu pour les interactions de disposition, d’automatisation et d’interface utilisateur. Vous devez dériver votre classe propriétaire de UIElement au moins, sinon il n’existe aucun moyen de créer l’homologue sur la charge d’arborescence Automation avec OnCreateAutomationPeer.