FrameworkElementAutomationPeer クラス

定義

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

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

Public Class FrameworkElementAutomationPeer
Inherits AutomationPeer

継承

Object IInspectable DependencyObject AutomationPeer FrameworkElementAutomationPeer

派生

Windows.UI.Xaml.Automation.Peers.AppBarAutomationPeer

Windows.UI.Xaml.Automation.Peers.AutoSuggestBoxAutomationPeer

Windows.UI.Xaml.Automation.Peers.ButtonBaseAutomationPeer

Windows.UI.Xaml.Automation.Peers.CalendarDatePickerAutomationPeer

Windows.UI.Xaml.Automation.Peers.CaptureElementAutomationPeer

その他…

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

例

この例では、FrameworkElementAutomationPeer からピアを派生させ、少なくとも 1 つのコントロール パターンをサポートするための基本的なサブクラス要件を示します。

このコードは、 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 ...
        }

次の C++/WinRT コード例の MIDL 3.0 ファイル。

// 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

    Public Class MediaContainerAP
        Inherits FrameworkElementAutomationPeer
        Implements IRangeValueProvider
        Implements IToggleProvider
' nondefault ctors omitted ...

        Protected Overrides Function GetPatternCore(patternInterface__1 As PatternInterface) As Object
            If patternInterface__1 = PatternInterface.RangeValue Then
                Return Me
            ElseIf patternInterface__1 = PatternInterface.Toggle Then
                Return Me
            End If
            Return Nothing
        End Function


        Protected Overrides Function GetAutomationControlTypeCore() As AutomationControlType
            Return AutomationControlType.Group
        End Function

        Protected Overrides Function GetLocalizedControlTypeCore() as String
            Return "Video"
        End Function

        Protected Overrides Function GetClassNameCore() As String
            Return "MediaElementContainer"
        End Function
' pattern implementation omitted ...
End Class

注釈

"ControlAutomationPeer" クラスはありません。 FrameworkElementAutomationPeer は、Microsoft UI オートメーションを含むすべての基本的な Control クラス シナリオの実装として機能します。 これには、AutomationPeer の多くのコア メソッドの実際の実装など、必ずしもパブリック API 公開として表示されない動作が含まれます。

FrameworkElementAutomationPeer には、他のピアが UIElement および FrameworkElement レベルの所有者クラスから取得した情報をレポートするために使用できるピア動作の広範な基本実装が含まれています。 詳細については、「 カスタム オートメーション ピア」の「FrameworkElementAutomationPeer での基本実装」セクションを参照してください。

Core オーバーライドに加えて、FrameworkElementAutomationPeer には、コントロール コード内からピア ハンドルを取得する場合や、Microsoft UI オートメーションサポート用の項目コンテナー ピアから項目ピアを生成する場合に便利な 2 つの静的ユーティリティ メソッドがあります。 これらのボタンの役割は、次のとおりです。

• CreatePeerForElement
• FromElement

カスタムオートメーションピアを定義する必要があり、所有者クラスの派生元のコントロールまたは基底クラスとペアになっているより派生したピア クラスを特定できない場合は、FrameworkElementAutomationPeer に基づいてピアをベースにする必要があります。 所有者クラスが必ずしも FrameworkElement ではない場合でも、FrameworkElementAutomationPeer にはレイアウト、オートメーション、UI の操作に期待される動作を提供する多くのオーバーライドがあるため、実質的に AutomationPeer からピアを直接派生することはできません。 少なくとも UIElement から所有者クラスを派生させる必要があります。それ以外の場合は、 OnCreateAutomationPeer を使用してオートメーション ツリーの読み込み時にピアを作成する方法はありません。

FrameworkElementAutomationPeer 派生クラス

FrameworkElementAutomationPeer は、Windows ランタイム コントロールと要素のピア サポートを実装するいくつかの直ちに派生したクラスの親クラスです。 これらのピア クラスの一部は、実際のコントロールではなく、コントロールの基底クラスと一致するピアです。 たとえば、ButtonBaseAutomationPeer が存在するため、ButtonBase から派生する実用的な Button クラスをサポートする複数のクラスの共有ピア動作を定義できます。 FrameworkElementAutomationPeer から直接派生するクラスの一覧を次に示します。

• AppBarAutomationPeer
• ButtonBaseAutomationPeer
• CaptureElementAutomationPeer
• ComboBoxItemAutomationPeer
• DatePickerAutomationPeer
• FlipViewItemAutomationPeer
• FlyoutPresenterAutomationPeer
• GridViewItemAutomationPeer
• GroupItemAutomationPeer
• HubAutomationPeer
• HubSectionAutomationPeer
• ItemsControlAutomationPeer
• ListBoxItemAutomationPeer
• ListViewBaseHeaderItemAutomationPeer
• ListViewItemAutomationPeer
• MediaElementAutomationPeer
• MenuFlyoutItemAutomationPeer
• PasswordBoxAutomationPeer
• ProgressRingAutomationPeer
• RangeBaseAutomationPeer
• RichEditBoxAutomationPeer
• RichTextBlockAutomationPeer
• RichTextBlockOverflowAutomation
• ScrollViewerAutomationPeer
• SearchBoxAutomationPeer
• SemanticZoomAutomationPeer
• SettingsFlyoutAutomationPeer
• TextBlockAutomationPeer
• TextBoxAutomationPeer
• ThumbAutomationPeer
• TimePickerAutomationPeer
• ToggleMenuFlyoutItemAutomationPeer
• ToggleSwitchAutomationPeer

コンストラクター

プロパティ

メソッド

適用対象

こちらもご覧ください

• FrameworkElement
• AutomationPeer
• カスタム オートメーション ピア
• Windows デスクトップ アプリでのプログラムによるアクセシビリティに関する一般的な問題を解決するためのコード サンプル