AutomationPeer クラス

定義

名前空間:: Microsoft.UI.Xaml.Automation.Peers

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

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

自動化イベントの発生

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 から直接派生するクラスは次のとおりです。

FrameworkElementAutomationPeer。 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()	この AutomationPeer で表されるコントロールを区別するために AutomationControlType で使用される名前を取得します。
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()	このオートメーションピアに関連付けられている要素に、ユーザーに表示されるデータが含まれているかどうかを示す値を取得します。
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)

適用対象

こちらもご覧ください

フィードバック

このページはお役に立ちましたか?