UI オートメーションによる Edit コントロール型のサポート

メモメモ

このドキュメントは、System.Windows.Automation 名前空間で定義されているマネージ UI Automation クラスを使用する .NET Framework 開発者を対象としています。UI Automationに関する最新情報については、「Windows Automation API: UI Automation (Windows オートメーション API: UI オートメーション)」を参照してください。

ここでは、UI Automationによる Edit コントロール型のサポートに関する情報を示します。 UI Automationでは、コントロール型は、ControlTypeProperty プロパティを使用するためにコントロールで満たす必要がある一連の条件となります。 これらの条件には、UI Automation ツリー構造、UI Automationのプロパティ値、およびコントロール パターンに関する特定のガイドラインが含まれます。

エディット コントロールでは、さまざまな書式設定機能のサポートなしで 1 行のテキストを表示、編集できます。

以下のセクションでは、Edit コントロール型の必須の UI Automation ツリー構造、プロパティ、コントロール パターン、およびイベントを示します。 UI Automationの各要件は、Windows Presentation Foundation (WPF)、Win32、Windows Formsのいずれの場合でも、すべてのエディット コントロールに当てはまります。

このトピックは、次のセクションで構成されています。

  • 必須の UI オートメーション ツリー構造
  • 必須の UI オートメーション プロパティ
  • 必須の UI オートメーション コントロール パターンおよびプロパティ
  • 必須の UI オートメーション イベント
  • 関連トピック

必須の UI オートメーション ツリー構造

次の表では、エディット コントロールに関連した UI Automation ツリーのコントロール ビューとコンテンツ ビューを示し、各ビューに格納できるものについて説明します。 UI Automation ツリーの詳細については、「UI オートメーション ツリーの概要」を参照してください。

コントロール ビュー

コンテンツ ビュー

Edit

Edit

Edit コントロール型を実装するコントロールは、単一行コントロールであるため、UI Automation ツリーのコントロール ビューにスクロール バーが表示されることはありません。 1 行のテキストは、一部のレイアウト シナリオで折り返される場合があります。 Edit コントロール型は、少量の編集可能なテキストまたは選択可能なテキストを保持する場合に最も適しています。

必須の UI オートメーション プロパティ

値または定義がエディット コントロールに特に関連する UI Automation のプロパティの一覧を次の表に示します。 UI Automation プロパティの詳細については、「クライアントの UI オートメーション プロパティ」を参照してください。

UI Automation プロパティ

説明

AutomationIdProperty

説明を参照。

このプロパティの値は、アプリケーションのすべてのコントロールで一意にする必要があります。

BoundingRectangleProperty

説明を参照。

コントロール全体を包含する外側の四角形。

ClickablePointProperty

説明を参照。

エディット コントロールには、ユーザーがその場所でマウスをクリックしたときに、コントロールの編集部分に入力フォーカスを設定する、クリック可能なポイントが必要です。

IsKeyboardFocusableProperty

説明を参照。

コントロールがキーボード フォーカスを受け取ることができる場合は、このプロパティをサポートする必要があります。

NameProperty

説明を参照。

エディット コントロールの名前は、通常、静的テキスト ラベルから生成されます。 静的テキスト ラベルが存在しない場合は、アプリケーションの開発時に Name のプロパティ値を割り当てる必要があります。 Name プロパティには、エディット コントロールのテキスト コンテンツを含めることができません。

LabeledByProperty

説明を参照。

コントロールに関連付けられた静的テキスト ラベルが存在する場合、このプロパティは、そのコントロールへの参照を公開する必要があります。 テキスト コントロールが別のコントロールのサブコンポーネントである場合、LabeledBy プロパティは設定されません。

ControlTypeProperty

Edit

この値は、すべての UI フレームワークで共通です。

LocalizedControlTypeProperty

"エディット"

Edit コントロール型に対応する、ローカライズされた文字列。

IsContentElementProperty

True

エディット コントロールは、常に UI Automation ツリーのコンテンツ ビューに含まれます。

IsControlElementProperty

True

エディット コントロールは、常に UI Automation ツリーのコントロール ビューに含まれます。

IsPasswordProperty

説明を参照。

パスワードを格納するエディット コントロールの場合は true に設定する必要があります。 エディット コントロールに実際にパスワード コンテンツが格納される場合、スクリーン リーダーはこのプロパティを使用して、ユーザーが入力するキーストロークを読み上げる必要があるかどうかを判別できます。

必須の UI オートメーション コントロール パターンおよびプロパティ

すべてのエディット コントロールでサポートする必要があるコントロール パターンの一覧を次の表に示します。 コントロール パターンの詳細については、「UI オートメーション コントロール パターンの概要」を参照してください。

コントロール パターン/コントロール パターン プロパティ

サポート/値

説明

ITextProvider

依存

エディット コントロールは、テキスト コントロール パターンをサポートする必要があります。これは、クライアントで常に詳細なテキスト情報を利用可能にする必要があるためです。

IValueProvider

依存

文字列を受け取るすべてのエディット コントロールは、値パターンを公開する必要があります。

IsReadOnly

説明を参照。

このプロパティは、プログラムを使用してコントロールに値を設定できるか、またはユーザーがコントロールを編集できるかを示すために設定する必要があります。

Value

説明を参照。

このプロパティは、エディット コントロールのテキスト コンテンツを返します。 IsPasswordProperty が true に設定されている場合、このプロパティは、要求されたときに InvalidOpertaionException を発生させる必要があります。

IRangeValueProvider

依存

数値の範囲を受け取るすべてのエディット コントロールは、Range Value コントロール パターンを公開する必要があります。

Minimum

説明を参照。

このプロパティは、エディット コントロールのコンテンツに対して設定できる最小の値にする必要があります。

Maximum

説明を参照。

このプロパティは、エディット コントロールのコンテンツに対して設定できる最大の値にする必要があります。

SmallChange

説明を参照。

このプロパティは、値に対して設定できる小数点以下の桁数を示す必要があります。 エディットが整数のみを受け取る場合は、SmallChangeProperty を 1 にします。 エディットが 1.0 から 2.0 の範囲を受け取る場合は、SmallChangeProperty を 0.1 にします。 エディット コントロールが 1.00 から 2.00 の範囲を受け取る場合は、SmallChangeProperty を 0.001 にします。

LargeChange

Null

このプロパティは、エディット コントロールで公開される必要はありません。

Value

説明を参照。

このプロパティは、エディット コントロールの数値コンテンツを示します。 Minimum および Maximum プロパティで指定された範囲内で、UI Automation クライアントによって、より精度の高い値が設定された場合、この Value プロパティは、受け入れられる最も近い値に自動的に丸められます。

必須の UI オートメーション イベント

すべてのエディット コントロールでサポートする必要がある UI Automation イベントを次の表に示します。 イベントの詳細については、「UI オートメーション イベントの概要」を参照してください。

UI Automation イベント

サポート

説明

InvalidatedEvent

必須

なし

TextSelectionChangedEvent

必須

なし

TextChangedEvent

必須

なし

BoundingRectangleProperty プロパティ変更イベント

必須

なし

IsOffscreenProperty プロパティ変更イベント

必須

なし

IsEnabledProperty プロパティ変更イベント

必須

なし

NameProperty プロパティ変更イベント

必須

なし

ValueProperty プロパティ変更イベント

依存

なし

HorizontallyScrollableProperty プロパティ変更イベント

なし

なし

HorizontalScrollPercentProperty プロパティ変更イベント

なし

なし

HorizontalViewSizeProperty プロパティ変更イベント

なし

なし

VerticalScrollPercentProperty プロパティ変更イベント

なし

なし

VerticallyScrollableProperty プロパティ変更イベント

なし

なし

VerticalViewSizeProperty プロパティ変更イベント

なし

なし

ValueProperty プロパティ変更イベント

依存

コントロールで Range Value コントロール パターンをサポートする場合は、このイベントをサポートする必要があります。

AutomationFocusChangedEvent

必須

なし

StructureChangedEvent

必須

なし

参照

参照

Edit

概念

UI オートメーション コントロール型の概要

UI オートメーションの概要