次の方法で共有


AutomationProperties クラス

定義

オートメーション プロパティのインスタンス レベルの値を取得または設定するためのサポートを提供します。 これらのプロパティ値は添付プロパティ (通常は XAML) として設定され、コントロールの AutomationPeer のオートメーション プロパティ値を補完またはオーバーライドします。

public ref class AutomationProperties sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 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(Windows.Foundation.UniversalApiContract), 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
属性

Windows の要件

デバイス ファミリ
Windows 10 (10.0.10240.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v1.0 で導入)

ヒント

WinUI 3 ギャラリー アプリを開き、次のアクセシビリティ原則の動作を確認します。

WinUI 3 ギャラリー アプリには、ほとんどの WinUI 3 コントロール、機能、および機能の対話型の例が含まれています。 Microsoft Store からアプリを取得するか、GitHub でソース コードを取得する

注釈

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

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

Name プロパティ

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

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

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

完全な一覧については、「 添付プロパティ 」を参照してください (各添付プロパティの詳細については、各プロパティの [識別子] フィールドを参照してください)。

バージョン履歴

Windows のバージョン SDK バージョン 追加された値
1511 10586 GetLandmarkType
1511 10586 GetLocalizedLandmarkType
1511 10586 SetLandmarkType
1511 10586 SetLocalizedLandmarkType
1607 14393 GetDescribedBy
1607 14393 GetFlowsFrom
1607 14393 GetFlowsTo
1607 14393 GetFullDescription
1607 14393 GetIsDataValidForForm
1607 14393 GetIsPeripheral
1607 14393 GetLocalizedControlType
1607 14393 SetFullDescription
1607 14393 SetIsDataValidForForm
1607 14393 SetIsPeripheral
1607 14393 SetLocalizedControlType
1703 15063 GetCulture
1703 15063 SetCulture
1803 17134 GetHeadingLevel
1803 17134 SetHeadingLevel
1809 17763 GetIsDialog
1809 17763 SetIsDialog

プロパティ

AcceleratorKeyProperty

AutomationProperties.AcceleratorKey 添付プロパティを識別します。

AccessibilityViewProperty

AutomationProperties.AccessibilityView 添付プロパティを識別します。

AccessKeyProperty

AutomationProperties.AccessKey 添付プロパティを識別します。

AnnotationsProperty

AutomationProperties.Annotations 添付プロパティを識別します。

AutomationControlTypeProperty

AutomationProperties.AutomationControlType 添付プロパティを識別します。

AutomationIdProperty

AutomationProperties.AutomationId 添付プロパティを識別します。

ControlledPeersProperty

AutomationProperties.ControlledPeers 添付プロパティを識別します。

CultureProperty

AutomationProperties.Culture 添付プロパティを識別します。

DescribedByProperty

AutomationProperties.DescribedBy 添付プロパティを識別します。

FlowsFromProperty

FlowsFrom 添付プロパティを識別します。

FlowsToProperty

FlowsTo 添付プロパティを識別します。

FullDescriptionProperty

AutomationProperties.FullDescription XAML 添付プロパティを識別します。

HeadingLevelProperty

HeadingLevel XAML 添付プロパティを識別します。

HelpTextProperty

AutomationProperties.HelpText XAML 添付プロパティを識別します。

IsDataValidForFormProperty

AutomationProperties.IsDataValidForForm XAML 添付プロパティを識別します。

IsDialogProperty

AutomationProperties.IsDialog XAML 添付プロパティを識別します。

IsPeripheralProperty

AutomationProperties.IsPeripheral XAML 添付プロパティを識別します。

IsRequiredForFormProperty

AutomationProperties.IsRequiredForForm XAML 添付プロパティを識別します。

ItemStatusProperty

AutomationProperties.ItemStatus XAML 添付プロパティを識別します。

ItemTypeProperty

AutomationProperties.ItemType XAML 添付プロパティを識別します。

LabeledByProperty

AutomationProperties.LabeledBy XAML 添付プロパティを識別します。

LandmarkTypeProperty

AutomationProperties.LandmarkType XAML 添付プロパティを識別します。

LevelProperty

AutomationProperties.Level XAML 添付プロパティを識別します。

LiveSettingProperty

AutomationProperties.LiveSetting XAML 添付プロパティを識別します。

LocalizedControlTypeProperty

AutomationProperties.LocalizedControlType XAML 添付プロパティを識別します。これは、オートメーション要素が表すコントロールの種類を説明するテキスト文字列です。

LocalizedLandmarkTypeProperty

AutomationProperties.LocalizedLandmarkType XAML 添付プロパティを識別します。

NameProperty

XAML 添付プロパティ AutomationProperties.Name 識別します。

PositionInSetProperty

AutomationProperties.PositionInSet XAML 添付プロパティを識別します。

SizeOfSetProperty

AutomationProperties.SizeOfSet XAML 添付プロパティを識別します。

添付プロパティ

AcceleratorKey

オートメーション要素のアクセラレータ キー (ショートカット キーとも呼ばれます) の組み合わせを含む文字列を取得または設定します。

AccessibilityView

要素の Microsoft UI オートメーション ツリー ビュー モードを取得または設定します。

AccessKey

オートメーション要素のアクセス キー文字を含む文字列を取得または設定します。

Annotations

コメント、ヘッダー、フッターなど、ドキュメント内の注釈オブジェクトの一覧を取得します。

AutomationControlType

Microsoft 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)

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

GetAutomationId(DependencyObject)

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

GetControlledPeers(DependencyObject)

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

GetCulture(DependencyObject)

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

GetDescribedBy(DependencyObject)

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

GetFlowsFrom(DependencyObject)

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

GetFlowsTo(DependencyObject)

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

GetFullDescription(DependencyObject)

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

GetHeadingLevel(DependencyObject)

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

GetHelpText(DependencyObject)

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

GetIsDataValidForForm(DependencyObject)

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

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)

指定した要素の AutomationProperties.Level プロパティの値を取得します。

GetLiveSetting(DependencyObject)

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

GetLocalizedControlType(DependencyObject)

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

GetLocalizedLandmarkType(DependencyObject)

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

GetName(DependencyObject)

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

GetPositionInSet(DependencyObject)

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

GetSizeOfSet(DependencyObject)

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

SetAcceleratorKey(DependencyObject, String)

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

SetAccessibilityView(DependencyObject, AccessibilityView)

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

SetAccessKey(DependencyObject, String)

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

SetAutomationControlType(UIElement, AutomationControlType)

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

SetAutomationId(DependencyObject, String)

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

SetCulture(DependencyObject, Int32)

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

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 添付プロパティの値を設定します。

適用対象

こちらもご覧ください