AutomationPeer.GetName メソッド

定義

名前空間:

Windows.UI.Xaml.Automation.Peers

このオートメーション ピアに関連付けられている要素を説明するテキストを取得します。 Microsoft UI オートメーション 名 の値は、Microsoft UI オートメーション フレームワークと対話してアプリの UI を表すときに、ほとんどの支援テクノロジで使用される主な識別子です。

public:
 virtual Platform::String ^ GetName() = GetName;

winrt::hstring GetName();

public string GetName();

function getName()

Public Function GetName () As String

戻り値

String

Platform::String

winrt::hstring

支援技術やその他の Microsoft UI オートメーション クライアントで使用される、ピアの所有者である要素の名前。

注釈

FrameworkElementAutomationPeer は、中間の GetNameCore 実装を提供することで 、GetName に動作を 導入します。 要素に LabeledByMicrosoft UI Automation プロパティの値がある場合、ラベル付け要素の Name 値が Name として使用されます。

FrameworkElementAutomationPeer では、そのコントロールのコンテンツ モデルにアクセスし、Name の便利な既定値を返すために、他の既定のピア クラスがオーバーライドする可能性がある、内部の GetPlainText メソッドを介した動作も導入されています。 たとえば、ContentControl 派生クラスでは、既定の Name として Content 値の文字列表現が使用されます。 これは、内部的に ContentControl が GetPlainText を 実装し、その動作をすべての ContentControl 派生クラスに付与するため、有効になります。 たとえば、Button の文字列値から便利な名前の既定値を取得する方法を次に示します。

他の特定のピアにも、中間の GetNameCore 実装があり、その特定のWindows ランタイム コントロールが Name の組み込み値を提供するのに役立つ方法を提供します。 これらの値のソースは、XAML またはアプリ ユーザー コードで通常設定される他の UI プロパティから取得されます。 たとえば、TextBoxAutomationPeer は、所有者 TextBox の Text プロパティの値を既定の名前として使用する動作を実装します。 ユーザー コードの観点からは、別の AutomationProperties.Name 値を適用することで、既定の動作をオーバーライドできます。 ピア実装者/プロバイダーの観点から、ピアの既定の動作は、既存のピアから新しいピア クラスを派生させ、 GetNameCore をオーバーライドし、少なくとも場合によっては基本実装を呼び出さない新しい実装を提供することで変更できます。

既定のWindows ランタイム コントロールに対する特定のピア クラスの既定の動作の詳細については、その特定のピア クラスのリファレンス トピックを参照し、「解説」セクションで実装に関するメモを探してください。

こちらもご覧ください

• カスタム オートメーション ピア