次の方法で共有


AutomationProperties クラス

定義

オートメーション プロパティのインスタンス レベルの値を取得または設定するためのサポートを提供します。 これらのプロパティ値は添付プロパティ (通常は 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 AutomationProperties
Public NotInheritable Class AutomationProperties
継承
Object Platform::Object IInspectable AutomationProperties
属性

注釈

XAML 添付プロパティ

AutomationProperties は、のいくつかの XAML 添付プロパティのホスト サービス クラスです。 これらの添付プロパティの目的は、UI 要素を Microsoft UI オートメーション アクセシビリティ フレームワークに報告する方法に関連するさまざまなインスタンスごとの値を設定できるようにすることです。 これは、UI 要素のクラスデザインが、その Microsoft UI オートメーション統合またはピア実装動作の一部として他の UI 関連のプロパティ値をまだ転送していない場合、または転送される値が Microsoft UI オートメーションに報告する値ではない場合に便利です。

アタッチされたプロパティへの XAML プロセッサ アクセスをサポートし、同等の get 操作と set 操作をコードに公開するために、各 XAML 添付プロパティには、Getset アクセサー メソッドのペアがあります。これは AutomationProperties のメンバーでもあります。 たとえば、GetName メソッドと SetName メソッドでは、名前添付プロパティを使用して XAML で設定するのではなく、Microsoft UI オートメーションに対するオートメーション 名前 値をレポートするための同等のコードのみのサポートが提供されます。 または、依存関係プロパティ システムを使用して添付プロパティの値を取得または設定できます。これにより、基になる値も Microsoft UI オートメーションに報告されます。 GetValue 呼び出すか、SetValueを し、設定する依存関係プロパティ識別子の引数と、値を取得または設定するターゲット オブジェクトへの参照を渡します。

Name プロパティ

さまざまな添付プロパティのうち、おそらく最も重要なものは 名前です。 これは、ユーザーがアクセシビリティ シナリオでアプリを操作するときに、支援技術によって最も頻繁にアクセスおよび報告される Name プロパティであるためです。 は、UI 要素の人間が判読できる識別子として機能します。

さまざまな UI 要素には、他の要素プロパティに基づいて既定の Name 値を提供できるピア 転送があります。 たとえば、Button クラスのピア 転送では、Button コンテンツの ToString 評価が転送され、この文字列が既定の Nameとして使用されます。 その既定値をオーバーライドしたり、Microsoft UI オートメーションの 使用できない UI 要素の場合に 名前 値を指定するには、XAML でその要素 添付プロパティ 設定します。 Microsoft UI オートメーション が重要である理由の詳細については、「基本的なアクセシビリティ情報を参照してください。 要素にピア提供の が既に含まれるかどうかをテストする方法の詳細については、「アクセシビリティ テストの参照してください。

ローカライズの理由から、XAML の Name の文字列値をハードコーディングしないようにする必要があります。 要素 x:Uid ディレクティブ を設定した場合は、RESW リソースを使用してプロパティをターゲットにし、ローカライズに異なる値を指定できます。 添付プロパティの場合、リソース識別子フォームには、名前空間と using: プレフィックスを含む、XAML 形式の添付プロパティの完全な修飾が必要です。 たとえば、x:Uid ディレクティブ 値が "sendButton" リソースの AutomationProperties.Name 添付プロパティ値をターゲットにするには、RESW リソース内の データ 項目の 値が

添付プロパティ

手記

添付プロパティの詳細については、プロパティの Identifier フィールドのページを参照してください。

添付プロパティ 形容
AcceleratorKey 指定した要素のアクセラレータ キーを取得または設定します。
AccessibilityView 要素の Microsoft UI オートメーション ツリー ビュー モードを取得または設定します。
AccessKey 指定した要素のアクセス キーを取得または設定します。
AutomationId Microsoft UI オートメーションに対して要素を一意に識別する文字列を取得または設定します。
文化 オートメーション要素のロケール識別子 ("en-US" や英語 (米国) の0x0409など) を取得または設定します。指定した要素のカルチャ プロパティの値。
FullDescription 要素の拡張説明テキストを含むローカライズされた文字列を取得または設定します。
HeadingLevel UI オートメーション要素の見出しレベルを取得または設定します。
HelpText 要素のヘルプ テキストを取得または設定します。
IsDataValidForForm データがフォームに対して有効かどうかを示す値を取得または設定します。
IsDialog オートメーション要素がダイアログ ウィンドウかどうかを示す値を取得または設定します。
IsPeripheral オートメーション要素が周辺機器 UI を表すかどうかを示す値を取得または設定します。
IsRequiredForForm 要素をフォームに入力する必要があるかどうかを示す値を取得または設定します。
ItemStatus 要素内の項目の状態の説明を取得または設定します。
ItemType 指定した要素の型の説明を取得または設定します。
LabeledBy 要素のテキスト ラベルを含む要素を取得または設定します。
LandmarkType 要素に関連付けられた ランドマーク型識別子 を取得または設定します。
レベル 階層構造または壊れた階層構造内の要素の位置を表す 1 から始まる整数を取得または設定します。
LiveSetting 指定した要素のライブ設定値を取得または設定します。
LocalizedControlType オートメーション要素が表すコントロールの種類を記述するローカライズされたテキスト文字列を取得または設定します。
LocalizedLandmarkType オートメーション要素が表すランドマークの種類を記述するローカライズされたテキスト文字列を取得または設定します。
名前 要素の 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

Level 添付プロパティの識別子を取得します。これは、オートメーション要素に関連付けられた 1 から始まる整数です。

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

兄弟と見なされる要素のセット内の要素の数を取得または設定します。

メソッド

GetAcceleratorKey(DependencyObject)

指定した DependencyObjectAutomationProperties.AcceleratorKey 添付プロパティの値を取得します。

GetAccessibilityView(DependencyObject)

指定した DependencyObjectAutomationProperties.AccessibilityView 添付プロパティの値を取得します。

GetAccessKey(DependencyObject)

指定した DependencyObjectAutomationProperties.AccessKey 添付プロパティの値を取得します。

GetAnnotations(DependencyObject)

指定した DependencyObjectAutomationProperties.Annotations プロパティの値を取得します。

GetAutomationControlType(UIElement)

指定した UI 要素の Microsoft.UI.Xaml.Automation.Peers.AutomationControlType を取得します。

GetAutomationId(DependencyObject)

指定した DependencyObjectAutomationProperties.AutomationId 添付プロパティの値を取得します。

GetControlledPeers(DependencyObject)

ターゲット所有者から制御されたピアの一覧を取得する静的ユーティリティ メソッド。

GetCulture(DependencyObject)

指定した DependencyObjectCultureProperty 添付プロパティの値を取得します。

GetDescribedBy(DependencyObject)

指定したオートメーション要素に関する詳細情報を提供する要素のコレクションを取得します。

GetFlowsFrom(DependencyObject)

指定したオートメーション要素の前に読み取り順序を提案するオートメーション要素の一覧を取得します。

GetFlowsTo(DependencyObject)

指定したオートメーション要素の後に読み取り順序を提案するオートメーション要素の一覧を取得します。

GetFullDescription(DependencyObject)

指定した DependencyObjectの外観または内容を記述するローカライズされた文字列を取得します。

GetHeadingLevel(DependencyObject)

指定した DependencyObjectAutomationProperties.HeadingLevel プロパティの値を取得します。

GetHelpText(DependencyObject)

指定した DependencyObjectAutomationProperties.HelpText 添付プロパティの値を取得します。

GetIsDataValidForForm(DependencyObject)

指定した要素に関連付けられているフォーム ルールに対して、入力または選択した値が有効かどうかを示すブール値を取得します。

GetIsDialog(DependencyObject)

指定した DependencyObjectAutomationProperties.IsDialog 添付プロパティの値を取得します。

GetIsPeripheral(DependencyObject)

指定した要素が周辺機器 UI を表すかどうかを示すブール値を取得します。

GetIsRequiredForForm(DependencyObject)

指定した DependencyObjectAutomationProperties.IsRequiredForForm 添付プロパティの値を取得します。

GetItemStatus(DependencyObject)

指定した DependencyObjectAutomationProperties.ItemStatus 添付プロパティの値を取得します。

GetItemType(DependencyObject)

指定した DependencyObjectAutomationProperties.ItemType 添付プロパティの値を取得します。

GetLabeledBy(DependencyObject)

指定した DependencyObjectAutomationProperties.LabeledBy 添付プロパティの値を取得します。

GetLandmarkType(DependencyObject)

指定した DependencyObjectのランドマーク型添付プロパティの値を取得します。

GetLevel(DependencyObject)

指定したプロパティの値を取得します。

GetLiveSetting(DependencyObject)

指定した DependencyObjectAutomationProperties.LiveSetting 添付プロパティの値を取得します。

GetLocalizedControlType(DependencyObject)

指定したコントロールの型を示すローカライズされた文字列を取得します。

GetLocalizedLandmarkType(DependencyObject)

指定した DependencyObjectのローカライズされたランドマーク型添付プロパティの値を取得します。

GetName(DependencyObject)

指定した DependencyObjectAutomationProperties.Name 添付プロパティの値を取得します。

GetPositionInSet(DependencyObject)

指定したプロパティの値を取得します。

GetSizeOfSet(DependencyObject)

指定したプロパティの値を取得します。

SetAcceleratorKey(DependencyObject, String)

指定した DependencyObjectAutomationProperties.AcceleratorKey 添付プロパティの値を設定します。

SetAccessibilityView(DependencyObject, AccessibilityView)

指定した DependencyObjectAutomationProperties.AccessibilityView 添付プロパティの値を設定します。

SetAccessKey(DependencyObject, String)

指定した DependencyObjectAutomationProperties.AccessKey 添付プロパティの値を設定します。

SetAutomationControlType(UIElement, AutomationControlType)

指定した UI 要素 Microsoft.UI.Xaml.Automation.Peers.AutomationControlType を設定します。

SetAutomationId(DependencyObject, String)

指定した DependencyObjectAutomationProperties.AutomationId 添付プロパティの値を設定します。

SetCulture(DependencyObject, Int32)

指定した DependencyObjectCultureProperty 添付プロパティの値を設定します。

SetFullDescription(DependencyObject, String)

指定した DependencyObjectの外観または内容を記述するローカライズされた文字列を設定します。

SetHeadingLevel(DependencyObject, AutomationHeadingLevel)

指定した DependencyObjectAutomationProperties.HeadingLevel プロパティの値を設定します。

SetHelpText(DependencyObject, String)

指定した DependencyObjectAutomationProperties.HelpText 添付プロパティの値を設定します。

SetIsDataValidForForm(DependencyObject, Boolean)

指定した要素に関連付けられたフォーム ルールに対して、入力または選択した値が有効かどうかを示すブール値を設定します。

SetIsDialog(DependencyObject, Boolean)

指定した要素をダイアログ ウィンドウとして識別するかどうかを示すブール値を設定します。

SetIsPeripheral(DependencyObject, Boolean)

指定した要素が周辺機器 UI を表すかどうかを示すブール値を設定します。

SetIsRequiredForForm(DependencyObject, Boolean)

指定した DependencyObjectAutomationProperties.IsRequiredForForm 添付プロパティの値を設定します。

SetItemStatus(DependencyObject, String)

指定した DependencyObjectAutomationProperties.ItemStatus 添付プロパティの値を設定します。

SetItemType(DependencyObject, String)

指定した DependencyObjectAutomationProperties.ItemType 添付プロパティの値を設定します。

SetLabeledBy(DependencyObject, UIElement)

指定した DependencyObjectAutomationProperties.LabeledBy 添付プロパティの値を設定します。

SetLandmarkType(DependencyObject, AutomationLandmarkType)

指定した DependencyObjectのランドマーク型添付プロパティの値を設定します。

SetLevel(DependencyObject, Int32)

指定した DependencyObjectAutomationProperties.Level 添付プロパティの値を設定します。

SetLiveSetting(DependencyObject, AutomationLiveSetting)

指定した DependencyObjectAutomationProperties.LiveSetting 添付プロパティの値を設定します。

SetLocalizedControlType(DependencyObject, String)

指定したコントロールの型を示すローカライズされた文字列を設定します。

SetLocalizedLandmarkType(DependencyObject, String)

指定した DependencyObjectのローカライズされたランドマーク型の添付プロパティの値を設定します。

SetName(DependencyObject, String)

指定した DependencyObjectAutomationProperties.Name 添付プロパティの値を設定します。

SetPositionInSet(DependencyObject, Int32)

指定した DependencyObjectAutomationProperties.PositionInSet 添付プロパティの値を設定します。

SetSizeOfSet(DependencyObject, Int32)

指定した DependencyObjectAutomationProperties.SizeOfSet 添付プロパティの値を設定します。

適用対象

こちらもご覧ください