UI オートメーションによる Document コントロール型のサポート
Note
このドキュメントは、System.Windows.Automation 名前空間で定義されているマネージド UI オートメーション クラスを使用する .NET Framework 開発者を対象としています。 UI オートメーションの最新情報については、Windows Automation API の「UI オートメーション」を参照してください。
このトピックでは、Document コントロール型に対する UI オートメーションのサポートに関する情報を提供します。 UI オートメーションでのコントロール型とは、コントロールで ControlTypeProperty プロパティを使用するために満たす必要がある条件のセットのことです。 この条件には、UI オートメーション ツリーの構造、UI オートメーションのプロパティ値、コントロール パターンに関する特定のガイドラインが含まれます。
ドキュメント コントロールを使用すると、ユーザーは複数ページのテキストを表示して操作できます。 書式設定されていない単純なテキスト行しかサポートしない編集コントロールとは異なり、ドキュメント コントロールは、さまざまなスタイルおよび書式を使用したテキストをホストできます。
以降のセクションでは、Document コントロール型に必要な UI オートメーション ツリーの構造、プロパティ、コントロール パターン、イベントを定義します。 この UI オートメーションの要件は、Windows Presentation Foundation (WPF)、Win32、または Windows フォームのいずれにおいても、すべてのドキュメント コントロールに適用されます。
必須の UI オートメーション ツリー構造
次の表に、ドキュメント コントロールに関連する UI オートメーション ツリーのコントロール ビューとコンテンツ ビューを示し、それぞれのビューに含めることができる内容について説明します。 UI オートメーション ツリーの詳細については、「UI オートメーション ツリーの概要」を参照してください。
| コントロール ビュー | コンテンツ ビュー |
|---|---|
| ドキュメント - Varies |
マニュアル名の正式名称 - Varies |
必須の UI オートメーション プロパティ
次の表に、ドキュメント コントロールに特に関連する値または定義を持つ UI オートメーション プロパティを示します。 UI オートメーション プロパティの詳細については、「クライアントの UI オートメーション プロパティ」を参照してください。
| UI Automation のプロパティ | 値 | Notes |
|---|---|---|
| AutomationIdProperty | 「ノート」を参照してください。 | このプロパティの値は、アプリケーション内のすべてのコントロールで一意である必要があります。 |
| BoundingRectangleProperty | 「ノート」を参照してください。 | コントロール全体を格納する最も外側の四角形。 |
| ClickablePointProperty | 「ノート」を参照してください。 | ドキュメントにはクリック可能なポイントがあり、そのポイントをクリックすると、ドキュメント コンテナー内のいずれかの要素のドキュメントがフォーカスを受け取ります。 |
| ControlTypeProperty | ドキュメント | この値は、すべての UI フレームワークで同じです。 |
| IsContentElementProperty | ○ | ドキュメント コントロールは、UI オートメーション ツリーのコンテンツ ビューに常に含まれます。 |
| IsControlElementProperty | True | ドキュメント コントロールは、UI オートメーション ツリーのコントロール ビューに常に含まれます。 |
| IsKeyboardFocusableProperty | 「ノート」を参照してください。 | コントロールがキーボード フォーカスを受け取ることができる場合は、このプロパティをサポートする必要があります。 |
| LabeledByProperty | 「ノート」を参照してください。 | このプロパティの値は、ドキュメント コントロールのラベルでなければなりません。 通常、ドキュメントのタイトルが使用されます。 |
| LocalizedControlTypeProperty | 「ドキュメント」 | Document コントロール型に対応する、ローカライズされた文字列。 |
| NameProperty | 「ノート」を参照してください。 | 通常、ドキュメント コントロールの名前は、読み込み元のファイル名から取得されます。 この名前は多くの場合、そのコントロールを格納するウィンドウまたはフレームのタイトルに表示されます。 |
必須の UI オートメーション コントロール パターン
次の表に、ドキュメント コントロールでサポートされる必要がある UI オートメーション コントロール パターンを示します。 コントロール パターンについて詳しくは、「 UI Automation Control Patterns Overview」をご覧ください。
| コントロール パターン | サポート | Notes |
|---|---|---|
| IScrollProvider | 依存 | ドキュメント コントロールは、ビューポートのスパンを超えてスパンできます。 コントロールのコンテンツがスクロール可能な場合は、Scroll コントロール パターンをサポートする必要があります。 |
| ITextProvider | 必須 | ドキュメント コントロールは、ビューポートのスパンを超えてスパンできます。 コントロールのコンテンツがスクロール可能な場合は、Scroll コントロール パターンをサポートする必要があります。 |
| IValueProvider | 行わない | 通常、ドキュメント コントロールのコンテンツは複数のページにまたがるため、ドキュメント コントロールはこのコントロール パターンをサポートしません。 UI オートメーション クライアントは、 TextPattern を使用してドキュメントに関するテキスト情報を取得する必要があります。 |
必須の UI オートメーション イベント
次の表に、すべてのドキュメント コントロールでサポートされる必要がある UI オートメーション イベントを示します。 イベントの詳細については、「 UI Automation Events Overview」を参照してください。
| UI オートメーション イベント | サポート | Notes |
|---|---|---|
| AutomationFocusChangedEvent | 必須 | なし |
| BoundingRectangleProperty プロパティ変更イベント。 | 必須 | なし |
| IsEnabledProperty プロパティ変更イベント。 | 必須 | なし |
| IsOffscreenProperty プロパティ変更イベント。 | 必須 | なし |
| StructureChangedEvent | 必須 | なし |
| HorizontallyScrollableProperty プロパティ変更イベント。 | 必須 | なし |
| HorizontalScrollPercentProperty プロパティ変更イベント。 | 必須 | なし |
| HorizontalViewSizeProperty プロパティ変更イベント。 | 必須 | なし |
| VerticalScrollPercentProperty プロパティ変更イベント。 | 必須 | なし |
| VerticallyScrollableProperty プロパティ変更イベント。 | 必須 | なし |
| VerticalViewSizeProperty プロパティ変更イベント。 | 必須 | なし |
| InvalidatedEvent | 依存 | コントロールが Selection コントロール パターンをサポートする場合は、このイベントをサポートする必要があります。 |
| TextSelectionChangedEvent | 必須 | なし |
| TextChangedEvent | 必須 | なし |
| ValueProperty プロパティ変更イベント。 | なし | なし |