AutomationProperties クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オートメーション プロパティのインスタンス レベルの値を取得または設定するためのサポートを提供します。 これらのプロパティ値は添付プロパティ (通常は XAML) として設定され、コントロールの AutomationPeer のオートメーション プロパティ値を補完またはオーバーライドします。
public ref class AutomationProperties sealed/// [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 AutomationProperties final[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 sealed class AutomationPropertiesPublic NotInheritable Class AutomationProperties- 継承
- 属性
注釈
XAML 添付プロパティ
AutomationProperties は、いくつかの XAML 添付プロパティのホスト サービス クラスです。 これらの添付プロパティの目的は、UI 要素をMicrosoft UI オートメーションアクセシビリティ フレームワークに報告する方法に関連するさまざまなインスタンスごとの値を設定できるようにすることです。 これは、UI 要素のクラスデザインが、そのMicrosoft UI オートメーション統合またはピア実装の動作の一部として他の UI 関連のプロパティ値をまだ転送していない場合、または転送される値がMicrosoft UI オートメーションに報告する値ではない場合に便利です。
添付プロパティへの XAML プロセッサ アクセスをサポートし、同等の取得操作と設定操作をコードに公開するために、各 XAML 添付プロパティには 、AutomationProperties のメンバーでもある Get アクセサーメソッドと Set アクセサー メソッドのペアがあります。 たとえば、GetName メソッドと SetName メソッドでは、XAML で設定するために Name 添付プロパティを使用する代わりに、オートメーションの名前の値をMicrosoft UI オートメーションにレポートするための同等のコードのみのサポートが提供されます。 または、依存関係プロパティ システムを使用して添付プロパティの値を取得または設定し、基になる値をMicrosoft UI オートメーションに報告することもできます。 GetValue または SetValue を呼び出し、設定する依存関係プロパティ識別子の引数と、値を取得または設定するターゲット オブジェクトへの参照を渡します。
Name プロパティ
さまざまな添付プロパティのうち、おそらく最も重要なものは Name です。 これは、ユーザーがアクセシビリティ シナリオでアプリを操作するときに支援技術によって最も頻繁にアクセスされ、報告される Name プロパティであるためです。 Name は、UI 要素の人間が判読できる識別子として機能します。
さまざまな UI 要素には、他の要素プロパティに基づいて既定の 名前 の値を提供できるピア 転送があります。 たとえば、Button クラスのピア フォワーディングは、Button コンテンツの ToString 評価を転送し、この文字列を既定の名前として使用します。 その既定値をオーバーライドしたり、使用できるMicrosoft UI オートメーション名前がない UI 要素の場合に Name 値を指定したりするには、XAML でその要素に Name 添付プロパティを設定します。 Microsoft UI オートメーション名が重要な理由の詳細については、「基本的なアクセシビリティ情報」を参照してください。 要素に、有効なピア指定 の名前 が既に含まれるかどうかをテストする方法の詳細については、「 アクセシビリティ テスト」を参照してください。
ローカライズの理由から、XAML の 名前 の文字列値をハードコーディングしないようにする必要があります。 要素に x:Uid ディレクティブ を設定した場合は、RESW リソースを使用してプロパティをターゲットにし、ローカライズに異なる値を指定できます。 添付プロパティの場合、リソース識別子フォームには、名前空間と using: プレフィックスを含む、XAML 形式の添付プロパティの完全な修飾が必要です。 たとえば、x:Uid ディレクティブ値が "sendButton" であるリソースの AutomationProperties.Name 添付プロパティ値をターゲットにするには、RESW リソース内のデータ項目の名前の値は次のようになります。sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name
添付プロパティ
Note
添付プロパティの詳細については、プロパティの [識別子] フィールドのページを参照してください。
| 添付プロパティ | Description |
|---|---|
| AcceleratorKey | 指定した要素のアクセラレータ キーを取得または設定します。
|
| AccessibilityView | 要素のMicrosoft UI オートメーション ツリー ビュー モードを取得または設定します。 |
| アクセスキー | 指定した要素のアクセス キーを取得または設定します。
|
| AutomationId | Microsoft UI オートメーションする要素を一意に識別する文字列を取得または設定します。
|
| 文化 | オートメーション要素のロケール識別子 ("en-US" や英語 (米国) の0x0409など) を取得または設定します。
|
| FullDescription | 要素の拡張説明テキストを含むローカライズされた文字列を取得または設定します。 |
| HeadingLevel | UI オートメーション要素の見出しレベルを取得または設定します。 |
| HelpText | 要素のヘルプ テキストを取得または設定します。
|
| IsDataValidForForm | データがフォームに対して有効かどうかを示す値を取得または設定します。 |
| IsDialog | オートメーション要素がダイアログ ウィンドウかどうかを示す値を取得または設定します。
|
| IsPeripheral | オートメーション要素が周辺機器 UI を表すかどうかを示す値を取得または設定します。
|
| IsRequiredForForm | 要素をフォームに入力する必要があるかどうかを示す値を取得または設定します。 |
| ItemStatus | 要素内の項目の状態の説明を取得または設定します。
|
| ItemType | 指定した要素の型の説明を取得または設定します。
|
| LabeledBy | 要素のテキスト ラベルを含む要素を取得または設定します。 |
| LandmarkType | 要素に関連付けられた ランドマーク型識別子 を取得または設定します。 |
| Level | 階層構造または壊れた階層構造内の要素の位置を表す 1 から始まる整数を取得または設定します。
|
| LiveSetting | 指定した要素のライブ設定値を取得または設定します。 |
| LocalizedControlType | オートメーション要素が表すコントロールの種類を記述するローカライズされたテキスト文字列を取得または設定します。 |
| LocalizedLandmarkType | オートメーション要素が表すランドマークの種類を記述するローカライズされたテキスト文字列を取得または設定します。 |
| Name | 要素のUI オートメーション名を取得または設定します。
|
| PositionInSet | 兄弟と見なされる要素のセット内の要素の序数位置を表す 1 から始まる整数を取得または設定します。
|
| SizeOfSet | 兄弟と見なされる要素のセット内の要素の数を取得または設定します。
|
プロパティ
| 名前 | 説明 |
|---|---|
| AcceleratorKeyProperty |
AutomationProperties.AcceleratorKey 添付プロパティを識別します。これは、オートメーション要素のアクセラレータ キー (ショートカット キーとも呼ばれます) の組み合わせを含む文字列です。 |
| AccessibilityViewProperty |
AutomationProperties.AccessibilityView 添付プロパティを識別します。 要素の可視性を、UI オートメーション クライアントによって要求された特定のモードに変更するには、個々の要素にこの添付プロパティを設定します。 |
| AccessKeyProperty |
AutomationProperties.AccessKey 添付プロパティを識別します。これは、オートメーション要素のアクセス キー文字を含む文字列です。 |
| AnnotationsProperty |
コメント、ヘッダー、フッターなど、ドキュメント内の注釈オブジェクトの一覧に使用される依存関係プロパティを識別します。 |
| AutomationControlTypeProperty |
AutomationProperties 添付プロパティ (Microsoft) を識別します。Ui。Xaml.Automation.Peers.AutomationControlType。 |
| AutomationIdProperty |
AutomationProperties.AutomationId 添付プロパティを識別します。これは、オートメーション要素のUI オートメーション識別子 (ID) を含む文字列です。 |
| ControlledPeersProperty |
指定したオートメーション要素によって操作できるオートメーション要素のコレクションに使用される、ControlledPeers 添付プロパティを識別します。 |
| CultureProperty |
オートメーション要素のロケール識別子を含むカルチャ添付プロパティの識別子を取得します (たとえば、"en-US" または英語 (米国) の0x0409)。 |
| DescribedByProperty |
添付プロパティによって記述される識別子を取得します。これは、オートメーション要素に関する詳細情報を提供する要素の配列です。 |
| FlowsFromProperty |
FlowsFrom 添付プロパティの識別子を取得します。これは、現在のオートメーション要素の前に読み取り順序を提案するオートメーション要素の配列です。 |
| FlowsToProperty |
FlowsTo 添付プロパティの識別子を取得します。これは、現在のオートメーション要素の後の読み取り順序を示すオートメーション要素の配列です。 |
| FullDescriptionProperty |
要素の拡張説明テキストを含むローカライズされた文字列を公開する、完全な説明添付プロパティの識別子を取得します。 |
| HeadingLevelProperty |
HeadingLevel 添付プロパティの識別子を取得します。これは、UI オートメーション要素の見出しレベルを示します。 |
| HelpTextProperty |
AutomationProperties.HelpText 添付プロパティを識別します。これは、オートメーション要素に関連付けられているヘルプ テキスト文字列です。 |
| IsDataValidForFormProperty |
データがフォームに対して有効かどうかを示すブール型の依存関係プロパティを識別します。 |
| IsDialogProperty |
AutomationProperties.IsDialog 添付プロパティを識別します。これは、オートメーション要素がダイアログ ウィンドウであるかどうかを示すブール値です。 |
| IsPeripheralProperty |
オートメーション要素が周辺機器 UI を表すかどうかを示すブール型の依存関係プロパティを識別します。 |
| IsRequiredForFormProperty |
AutomationProperties.IsRequiredForForm 添付プロパティを識別します。これは、オートメーション要素をフォームに入力する必要があるかどうかを示すブール値です。 |
| ItemStatusProperty |
ItemStatus 添付プロパティを識別します。これは、オートメーション要素項目の状態を表します。 |
| ItemTypeProperty |
AutomationProperties.ItemType 添付プロパティを識別します。これは、オートメーション要素の型を記述するテキスト文字列です。 |
| LabeledByProperty |
AutomationProperties.LabeledBy 添付プロパティを識別します。これは、この要素のテキスト ラベルを含むオートメーション要素です。 |
| LandmarkTypeProperty |
要素に関連付けられたランドマーク型識別子であるランドマーク型添付プロパティの 識別子 を取得します。 |
| LevelProperty |
オートメーション要素に関連付けられた 1 から始まる整数である Level 添付プロパティの識別子を取得します。 |
| LiveSettingProperty |
AutomationProperties.LiveSetting 添付プロパティを識別します。これは、ライブ領域を表すオートメーション要素によってサポートされます。 |
| LocalizedControlTypeProperty |
ローカライズされたコントロール型の依存関係プロパティを識別します。これは、オートメーション要素が表すコントロールの型を記述するテキスト文字列です。 |
| LocalizedLandmarkTypeProperty |
ローカライズされたランドマーク型の添付プロパティの識別子を取得します。これは、オートメーション要素が表すランドマークの種類を記述するローカライズされたテキスト文字列です。 |
| NameProperty |
AutomationProperties.Name 添付プロパティを識別します。これは、オートメーション要素の名前を保持する文字列です。 |
| PositionInSetProperty |
PositionInSet 添付プロパティの識別子を取得します。これは、オートメーション要素に関連付けられた 1 から始まる整数です。 |
| SizeOfSetProperty |
添付プロパティの識別子を取得します。 |
添付プロパティ
| 名前 | 説明 |
|---|---|
| AcceleratorKey |
オートメーション要素のアクセラレータ キー (ショートカット キーとも呼ばれます) の組み合わせを含む文字列を取得または設定します。 |
| AccessibilityView |
要素のMicrosoft UI オートメーション ツリー ビュー モードを取得または設定します。 |
| AccessKey |
オートメーション要素のアクセス キー文字を含む文字列を取得または設定します。 |
| Annotations |
コメント、ヘッダー、フッターなど、ドキュメント内の注釈オブジェクトの一覧を取得します。 |
| AutomationControlType |
Microsoft UI オートメーション クライアントに公開されるユーザー インターフェイス (UI) 要素の種類を識別します。 |
| AutomationId |
Microsoft UI オートメーションする要素を一意に識別する文字列を取得または設定します。 |
| ControlledPeers |
指定したオートメーション要素によって操作できるオートメーション要素のコレクションを取得します。 |
| Culture |
オートメーション要素のロケール識別子 ("en-US" や英語 (米国) の0x0409など) を取得または設定します。 |
| DescribedBy |
オートメーション要素に関する詳細情報を提供する要素の配列を取得します。 |
| FlowsFrom |
現在のオートメーション要素の前に読み取り順序を提案するオートメーション要素の配列を取得します。 |
| FlowsTo |
現在のオートメーション要素の後の読み取り順序を示すオートメーション要素の配列を取得します。 |
| FullDescription |
要素の拡張説明テキストを含むローカライズされた文字列を取得または設定します。 |
| HeadingLevel |
UI オートメーション要素の見出しレベルを取得または設定します。 |
| HelpText |
オートメーション要素に関連付けられているヘルプ テキスト文字列を取得または設定します。 |
| IsDataValidForForm |
データがフォームに対して有効かどうかを示す値を取得または設定します。 |
| IsDialog |
オートメーション要素がダイアログ ウィンドウかどうかを示す値を取得または設定します。 |
| IsPeripheral |
オートメーション要素が周辺機器 UI を表すかどうかを示す値を取得または設定します。 |
| IsRequiredForForm |
要素をフォームに入力する必要があるかどうかを示す値を取得または設定します。 |
| ItemStatus |
要素内の項目の状態の説明を取得または設定します。 |
| ItemType |
指定した要素の型の説明を取得または設定します。 |
| LabeledBy |
この要素のテキスト ラベルを含むオートメーション要素を取得または設定します。 |
| LandmarkType |
要素に関連付けられた ランドマーク型識別子 を取得または設定します。 |
| Level |
階層構造または壊れた階層構造内の要素の位置を表す 1 から始まる整数を取得または設定します。 |
| LiveSetting |
ライブ領域を表すオートメーション要素でサポートされている、指定した要素のライブ設定値を取得または設定します。 |
| LocalizedControlType |
オートメーション要素が表すコントロールの種類を記述するローカライズされたテキスト文字列を取得または設定します。 |
| LocalizedLandmarkType |
オートメーション要素が表すランドマークの種類を記述するローカライズされたテキスト文字列を取得または設定します。 |
| Name |
要素のUI オートメーション名を取得または設定します。 |
| PositionInSet |
兄弟と見なされる要素のセット内の要素の序数位置を表す 1 から始まる整数を取得または設定します。 |
| SizeOfSet |
兄弟と見なされる要素のセット内の要素の数を取得または設定します。 |