FrameworkElementAutomationPeer 類別

定義

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

繼承

Object IInspectable DependencyObject AutomationPeer FrameworkElementAutomationPeer

衍生

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

更多…

屬性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

範例

此範例顯示從 FrameworkElementAutomationPeer 衍生對等的基本子類別需求，並支援至少一個控件模式。

此程式代碼是 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

備註

沒有 「ControlAutomationPeer」 類別。 FrameworkElementAutomationPeer 可作為涉及Microsoft UI 自動化之所有基本 Control 類別案例的實作。 這包括不一定顯示為公用 API 公開的行為，例如來自 automationPeer的許多 Core 方法的實際實作。

FrameworkElementAutomationPeer 包含對等行為的廣泛基底實作，其他對等可用來報告來自 UIElement 和 FrameworkElement 層級擁有者類別的資訊。 如需詳細資訊，請參閱 自定義自動化對等的一節。

除了 Core 覆寫之外，FrameworkElementAutomationPeer 還有兩個靜態公用程式方法，可用於從控件程式代碼內取得對等句柄，或從專案容器對等專案產生對等專案，以進行Microsoft UI 自動化支援。 以下是：

• CreatePeerForElement
• FromElement

如果您需要定義自定義自動化對等，且無法識別與衍生自擁有者類別的控件或基類配對的衍生對等類別，您應該以 FrameworkElementAutomationPeer 作為對等基礎。 即使擁有者類別不一定是 FrameworkElement，您也無法直接從 automationPeer 衍生對等，因為 FrameworkElementAutomationPeer 有許多覆寫，可提供配置、自動化和 UI 互動的預期行為。 您至少必須從 UIElement 衍生擁有者類別，否則無法透過 OnCreateAutomationPeer在自動化樹狀結構 載入上建立對等。

FrameworkElementAutomationPeer 衍生類別

FrameworkElementAutomationPeer 是數個立即衍生類別的父類別，可實作 Windows 運行時間控件和元素的對等支援。 其中有些對等類別是符合控件基類而非實際控件的對等。 例如，ButtonBaseAutomationPeer 存在，因此它可以定義數個類別的共用對等行為，這些類別支援衍生自 ButtonBase的實際 Button 類別。 以下是直接衍生自 FrameworkElementAutomationPeer 的類別列表：

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

建構函式

屬性

方法

適用於

另請參閱

• FrameworkElement
• AutomationPeer
• 自定義自動化對等
• 程式代碼範例，以解決 Windows 傳統型應用程式中常見的程式設計輔助功能問題