AutomationPeer クラス

定義

名前空間:

Microsoft.UI.Xaml.Automation.Peers

関連付けられた所有者クラスのオートメーション ピアを Microsoft UI オートメーションに公開する基底クラスを提供します。

public ref class AutomationPeer : DependencyObject

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

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

Public Class AutomationPeer
Inherits DependencyObject

継承

Object Platform::Object IInspectable DependencyObject AutomationPeer

派生

Microsoft.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer

Microsoft.UI.Xaml.Automation.Peers.ItemAutomationPeer

Microsoft.UI.Xaml.Automation.Peers.LoopingSelectorItemDataAutomationPeer

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

注釈

AutomationPeer は、最終的に C++、C#、または Visual Basic を使用して UWP アプリの Microsoft UI オートメーション情報を Microsoft UI オートメーション クライアントに転送するほぼすべての API を提供するクラスです。 一般的な Microsoft UI オートメーション クライアントは、AutomationPeer メソッドを直接呼び出していません。 これらのクライアントは、多くの場合、他のプログラミング モデルを使用し、サービスとして動作する支援技術であり、Windows ランタイムメソッドを呼び出す可能性は高くありません。 ただし、Windows ランタイムの一般的な Microsoft UI オートメーション サポートは、Microsoft UI オートメーション フレームワークのプロバイダー側を使用して、この情報をすべて転送します。 Microsoft UI オートメーションへのクライアントは、C++、C#、または Visual Basic を使用して、UWP アプリの代表的なオートメーション ツリーと対話できます。

オートメーション イベントの発生

AutomationPeer クラスは、実行時に OnCreateAutomationPeer メソッドを呼び出した後にピア インスタンスを使用できるため、Windows ランタイムコントロールの作成者に関連します。 このピアを使用すると、 RaiseAutomationEvent と RaisePropertyChangedEvent を呼び出すことでオートメーション イベントを発生させることができます。 これは、ピアの所有者 (クラス) の関連プロパティが変更されたときや、正しい自動化サポートのためにイベントを発生させる必要がある場合に常に行います。

オートメーション サポート設計では、 OnCreateAutomationPeer を実装する方法の一部として、独自のピアへのハンドルは保持されません。これは、ピアが実際に作成されるタイミングの保証がないためです。 代わりに、次のようなコードを使用して、Just-In-Time コントロール クラス定義内のランタイム オートメーション イベント リスナーをチェックできます。

if (AutomationPeer.ListenerExists(AutomationEvents.PropertyChanged))
{
    MyAutomationPeer peer = 
        FrameworkElementAutomationPeer.FromElement(myCtrl) as MyAutomationPeer;

    if (peer != null)
    {
        peer.RaisePropertyChangedEvent(
            RangeValuePatternIdentifiers.ValueProperty,
            (double)oldValue,
            (double)newValue);
    }
}

AutomationPeer 派生クラス

AutomationPeer は、Windows ランタイム コントロールと関連する UI クラスのすべての既存のピアの階層にあります。

AutomationPeer から直接派生するクラスは次のとおりです。

• ItemAutomationPeer
• FrameworkElementAutomationPeerFrameworkElementAutomationPeer。 FrameworkElementAutomationPeer から派生するピアの一覧については、「FrameworkElementAutomationPeer」の「解説」セクションを参照してください。

コア メソッド

"Core" メソッドは、関連付けられた Microsoft UI オートメーション クライアント呼び出し可能メソッドの既定のアクションを実行する標準実装です。 "Core" メソッドのいずれかをオーバーライドして、カスタム オートメーション ピアで代替値を返すことができます。 たとえば、 GetAcceleratorKeyCore は、 GetAcceleratorKey が呼び出されるたびに呼び出され、 GetAccessKeyCore は GetAccessKey が呼び出されるたびに呼び出されます。

AutomationPeer の基本実装は null を返します。 項目を表すピアは、結果をコンテナーに遅延させる可能性があります。

コンストラクター

AutomationPeer()

AutomationPeer 派生クラスの基底クラス初期化動作を提供します。

プロパティ

Dispatcher	常に Windows アプリ SDK アプリで を返しますnull。 代わりに DispatcherQueue を使用してください。 (継承元 DependencyObject)
DispatcherQueue	このオブジェクトが DispatcherQueue 関連付けられている を取得します。 は DispatcherQueue 、コードが UI 以外のスレッドによって開始された場合でも、UI スレッド上の にアクセス DependencyObject できる機能を表します。 (継承元 DependencyObject)
EventsSource	この AutomationPeer から取得されるすべてのイベントのソースとしてオートメーション クライアントに報告される AutomationPeer を取得または設定します。 「解説」を参照してください。

メソッド

ClearValue(DependencyProperty)	依存関係プロパティのローカル値をクリアします。 (継承元 DependencyObject)
GenerateRawElementProviderRuntimeId()	オートメーション ピアに関連付けられている 要素のランタイム識別子を生成します。
GetAcceleratorKey()	UI オートメーション ピアに関連付けられているオブジェクトのアクセラレータ キーの組み合わせを取得します。
GetAcceleratorKeyCore()	Microsoft UI オートメーション クライアントが GetAcceleratorKey または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetAccessKey()	オートメーション ピアに関連付けられている要素のアクセス キーを取得します。
GetAccessKeyCore()	Microsoft UI オートメーション クライアントが GetAccessKey または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetAnimationBaseValue(DependencyProperty)	依存関係プロパティに対して確立された基本値を返します。これは、アニメーションがアクティブでない場合に適用されます。 (継承元 DependencyObject)
GetAnnotations()	現在のオートメーション ピアの UI オートメーション注釈の一覧への参照を取得します。
GetAnnotationsCore()	Microsoft UI オートメーション クライアントが GetAnnotations または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetAutomationControlType()	UI オートメーション ピアに関連付けられている要素のコントロール型を取得します。
GetAutomationControlTypeCore()	Microsoft UI オートメーション クライアントが GetAutomationControlType または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetAutomationId()	オートメーション ピアに関連付けられている要素の AutomationId を取得します。
GetAutomationIdCore()	Microsoft UI オートメーション クライアントが GetAutomationId または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetBoundingRectangle()	オートメーション ピアに関連付けられている要素の画面座標を表す Rect オブジェクトを取得します。
GetBoundingRectangleCore()	Microsoft UI オートメーション クライアントが GetBoundingRectangle または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetChildren()	オートメーション ピアの直接の子要素としてUI オートメーション ツリーで表される子要素のコレクションを取得します。
GetChildrenCore()	Microsoft UI オートメーション クライアントが GetChildren または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetClassName()	AutomationControlType で使用される名前を取得し、この AutomationPeer で表されるコントロールを区別します。
GetClassNameCore()	Microsoft UI オートメーション クライアントが GetClassName または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetClickablePoint()	マウス クリックに応答するオートメーション ピアに関連付けられている 要素のポイントを取得します。
GetClickablePointCore()	Microsoft UI オートメーション クライアントが GetClickablePoint または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetControlledPeers()	Microsoft UI オートメーション クライアントが GetControlledPeers または同等の Microsoft UI オートメーション クライアント API (UIA_ControllerForPropertyIdで識別されるプロパティ値の取得など) を呼び出すときのピアの動作を提供します。
GetControlledPeersCore()	現在のオートメーション ピアの制御されたピアの一覧を取得します。
GetCulture()	GetCultureCore を呼び出して、オートメーション ピアに関連付けられている要素のカルチャ値を取得します。
GetCultureCore()	オートメーション ピアに関連付けられている要素のカルチャ値を取得します。
GetDescribedByCore()	オートメーション要素に関する詳細情報を提供する要素のコレクションを取得します。
GetElementFromPoint(Point)	指定したポイントから要素を取得します。
GetElementFromPointCore(Point)	Microsoft UI オートメーション クライアントが GetElementFromPoint または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetFlowsFromCore()	Microsoft UI オートメーション クライアントが AutomationProperties.GetFlowsFrom または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetFlowsToCore()	Microsoft UI オートメーション クライアントが AutomationProperties.GetFlowsTo または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetFocusedElement()	現在フォーカスがある要素を取得します。
GetFocusedElementCore()	Microsoft UI オートメーション クライアントが GetFocusedElement または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetFullDescription()	イメージやイメージ コントロールなどの実際の外観またはコンテンツを記述するローカライズされた文字列を取得します。
GetFullDescriptionCore()	Microsoft UI オートメーション クライアントが GetFullDescription または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetHeadingLevel()	このオートメーション ピアに関連付けられているUI オートメーション要素の見出しレベルを取得します。
GetHeadingLevelCore()	Microsoft UI オートメーション クライアントが GetHeadingLevel または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetHelpText()	オートメーション ピアに関連付けられているコントロールの機能を説明するテキストを取得します。
GetHelpTextCore()	Microsoft UI オートメーション クライアントが GetHelpText または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetItemStatus()	オートメーション ピアに関連付けられている要素の表示状態を表すテキストを取得します。
GetItemStatusCore()	Microsoft UI オートメーション クライアントが GetItemStatus または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetItemType()	要素が表す項目の種類を表す文字列を取得します。
GetItemTypeCore()	Microsoft UI オートメーション クライアントが GetItemType または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetLabeledBy()	要素を対象とする UIElement の AutomationPeer を取得します。
GetLabeledByCore()	Microsoft UI オートメーション クライアントが GetLabeledBy または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetLandmarkType()	このオートメーション ピアのランドマークの種類を取得します。
GetLandmarkTypeCore()	Microsoft UI オートメーション クライアントが GetLandmarkType または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetLevel()	オートメーション ピアに関連付けられている要素のレベル (階層) の 1 から始まる整数を返します。
GetLevelCore()	Microsoft UI オートメーション クライアントが GetLevel または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetLiveSetting()	UI オートメーション ピアに関連付けられているオブジェクトのライブ設定通知動作情報を取得します。
GetLiveSettingCore()	Microsoft UI オートメーション クライアントが GetLiveSetting または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetLocalizedControlType()	このオートメーション ピアに関連付けられているコントロールの AutomationControlType 値を表すローカライズされた文字列を取得します。
GetLocalizedControlTypeCore()	Microsoft UI オートメーション クライアントが GetLocalizedControlType または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetLocalizedLandmarkType()	このオートメーション ピアに関連付けられている要素の AutomationLandmarkType 値を表すローカライズされた文字列を取得します。
GetLocalizedLandmarkTypeCore()	Microsoft UI オートメーション クライアントが GetLocalizedLandmarkType または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetName()	このオートメーション ピアに関連付けられている要素を説明するテキストを取得します。 Microsoft UI オートメーション名の値は、Microsoft UI オートメーション フレームワークと対話してアプリの UI を表すときに最も支援技術によって使用される主な識別子です。
GetNameCore()	Microsoft UI オートメーション クライアントが GetName または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetOrientation()	コントロールの向きが明示的に設定されている場合にその向きを示す値を取得します。
GetOrientationCore()	Microsoft UI オートメーション クライアントが GetOrientation または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetParent()	この AutomationPeer の親である AutomationPeer を取得します。
GetPattern(PatternInterface)	指定した PatternInterface に関連付けられているコントロール パターンを取得します。
GetPatternCore(PatternInterface)	Microsoft UI オートメーション クライアントが GetPattern または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetPeerFromPoint(Point)	指定したポイントから AutomationPeer を取得します。
GetPeerFromPointCore(Point)	Microsoft UI オートメーション クライアントが GetPeerFromPoint または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetPositionInSet()	オートメーション ピアに関連付けられている要素のセット内の序数位置の 1 から始まる整数を返します。
GetPositionInSetCore()	Microsoft UI オートメーション クライアントが GetPositionInSet または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetSizeOfSet()	オートメーション ピアに関連付けられている要素が配置されているセットのサイズの 1 から始まる整数を返します。
GetSizeOfSetCore()	Microsoft UI オートメーション クライアントが GetSizeOfSet または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
GetValue(DependencyProperty)	DependencyObject から依存関係プロパティの現在の有効な値を返します。 (継承元 DependencyObject)
HasKeyboardFocus()	このオートメーション ピアに関連付けられている要素に現在キーボード フォーカスがあるかどうかを示す値を取得します。
HasKeyboardFocusCore()	Microsoft UI オートメーション クライアントが HasKeyboardFocus または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
InvalidatePeer()	AutomationPeer のメインプロパティの再計算をトリガーし、プロパティが変更された場合は PropertyChanged 通知をオートメーション クライアントに送信します。
IsContentElement()	この Automation Peer に関連付けられている要素が、ユーザーに提示されるデータを含むかどうかを示す値を取得します。
IsContentElementCore()	Microsoft UI オートメーション クライアントが IsContentElement または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
IsControlElement()	要素がユーザーによって対話型として認識されるか、GUI のコントロールの論理構造に寄与していると認識されるかを示す値を取得します。
IsControlElementCore()	Microsoft UI オートメーション クライアントが IsControlElement または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
IsDataValidForForm()	入力した値または選択した値がオートメーション要素に関連付けられているフォーム ルールに対して有効かどうかを示すブール値を取得します。
IsDataValidForFormCore()	Microsoft UI オートメーション クライアントが IsDataValidForForm または同等の Microsoft UI オートメーション クライアント API にアクセスした場合のピアの動作を提供します。
IsDialog()	このオートメーション ピアに関連付けられている要素がダイアログ ウィンドウであるかどうかを示す値を取得します。
IsDialogCore()	Microsoft UI オートメーション クライアントが IsDialog または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
IsEnabled()	このオートメーション ピアに関連付けられている要素で対話がサポートされるかどうかを示す値を取得します。
IsEnabledCore()	Microsoft UI オートメーション クライアントが IsEnabled または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
IsKeyboardFocusable()	要素がキーボード フォーカスを受け入れることができるかどうかを示す値を取得します。
IsKeyboardFocusableCore()	Microsoft UI オートメーション クライアントが IsKeyboardFocusable または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
IsOffscreen()	要素が画面から外れているかどうかを示す値を取得します。
IsOffscreenCore()	Microsoft UI オートメーション クライアントが IsOffscreen または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
IsPassword()	機密情報が要素に格納されているかどうか示す値を取得します。
IsPasswordCore()	Microsoft UI オートメーション クライアントが IsPassword または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
IsPeripheral()	オートメーション要素が周辺機器 UI を表すかどうかを示すブール値を取得します。
IsPeripheralCore()	Microsoft UI オートメーション クライアントが IsPeripheral または同等の Microsoft UI オートメーション クライアント API にアクセスするときのピアの動作を提供します。
IsRequiredForForm()	このピアに関連付けられている要素がフォームの必須要素かどうかを示す値を取得します。
IsRequiredForFormCore()	Microsoft UI オートメーション クライアントが IsRequiredForForm または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
ListenerExists(AutomationEvents)	指定したイベントをクライアントがリッスンしていることを Microsoft UI オートメーションが報告するかどうかを示す値を取得します。
Navigate(AutomationNavigationDirection)	UI オートメーション ツリー内の指定した方向の要素を取得します。
NavigateCore(AutomationNavigationDirection)	Microsoft UI オートメーション クライアントが Navigate または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
PeerFromProvider(IRawElementProviderSimple)	指定した IRawElementProviderSimple プロキシの AutomationPeer を取得します。
ProviderFromPeer(AutomationPeer)	指定した AutomationPeer の IRawElementProviderSimple プロキシを取得します。
RaiseAutomationEvent(AutomationEvents)	オートメーション イベントを発生させます。
RaiseNotificationEvent(AutomationNotificationKind, AutomationNotificationProcessing, String, String)	通知イベントを開始します。
RaisePropertyChangedEvent(AutomationProperty, Object, Object)	変更されたプロパティ値をオートメーション クライアントに通知するイベントを発生させます。
RaiseStructureChangedEvent(AutomationStructureChangeType, AutomationPeer)	ツリー構造が変更されたことを Microsoft UI オートメーション コアに通知するイベントを発生させます。
RaiseTextEditTextChangedEvent(AutomationTextEditChangeType, IVectorView<String>)	テキスト コントロールがプログラムによってテキストを変更したことを Microsoft UI オートメーション コアに通知するイベントを発生させます。
ReadLocalValue(DependencyProperty)	ローカル値が設定されている場合は、依存関係プロパティのローカル値を返します。 (継承元 DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	この DependencyObject インスタンスの特定の DependencyProperty に対する変更をリッスンするための通知関数を登録します。 (継承元 DependencyObject)
SetFocus()	このオートメーション ピアに関連付けられている要素にキーボード フォーカスを設定します。
SetFocusCore()	Microsoft UI オートメーション クライアントが SetFocus または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
SetParent(AutomationPeer)	この AutomationPeer の親である AutomationPeer を設定します。
SetValue(DependencyProperty, Object)	DependencyObject の依存関係プロパティのローカル値を設定します。 (継承元 DependencyObject)
ShowContextMenu()	owner 要素で使用できるコンテキスト メニューを表示します。
ShowContextMenuCore()	Microsoft UI オートメーション クライアントが ShowContextMenu または同等の Microsoft UI オートメーション クライアント API を呼び出すときのピアの動作を提供します。
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	RegisterPropertyChangedCallback を呼び出して以前に登録した変更通知を取り消します。 (継承元 DependencyObject)

こちらもご覧ください

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