ドキュメント コントロールの種類
このトピックでは、ドキュメント コントロールの種類に対する Microsoft UI オートメーション サポートについて説明します。
ドキュメント コントロールを使用すると、ユーザーは複数ページのテキストを表示して操作できます。 書式設定されていないテキストの単純な行のみをサポートする編集コントロールとは異なり、ドキュメント コントロールでは、スタイルが豊富で書式設定されたテキストをホストできます
次のセクションでは、Document コントロール型に必要なUI オートメーションツリー構造、プロパティ、コントロール パターン、およびイベントを定義します。 UI オートメーション要件は、UI フレームワーク/プラットフォームがコントロールの種類とコントロール パターンのサポートUI オートメーション統合するすべてのドキュメント コントロールに適用されます。
このトピックは、次のセクションで構成されています。
一般的なツリー構造
次の表は、ドキュメント コントロールに関連するUI オートメーション ツリーの一般的なコントロールとコンテンツ ビューを示し、各ビューに含めることができる内容について説明します。 UI オートメーション ツリーの詳細については、「UI オートメーション ツリーの概要」を参照してください。
| コントロール ビュー | コンテンツ ビュー |
|---|---|
|
|
関連するプロパティ
次の表に、ドキュメント コントロールに特に関連する値または定義を持つ UI オートメーション プロパティを示します。 UI オートメーションプロパティの詳細については、「UI オートメーション要素からのプロパティの取得」を参照してください。
| UI Automation のプロパティ | 値 | メモ |
|---|---|---|
| UIA_AutomationIdPropertyId | 「ノート」を参照してください。 | このプロパティの値は、UI オートメーション ツリーの生ビュー内のすべてのピア要素間で一意である必要があります。 |
| UIA_BoundingRectanglePropertyId | 「ノート」を参照してください。 | コントロール全体を格納する最も外側の四角形。 |
| UIA_ClickablePointPropertyId | 「ノート」を参照してください。 | ドキュメントにはクリック可能なポイントがあり、そのポイントをクリックすると、ドキュメント コンテナー内のいずれかの要素のドキュメントがフォーカスを受け取ります。 |
| UIA_ControlTypePropertyId | Document | |
| UIA_IsContentElementPropertyId | true | ドキュメント コントロールは、UI オートメーション ツリーのコンテンツ ビューに常に含まれます。 |
| UIA_IsControlElementPropertyId | true | ドキュメント コントロールは、UI オートメーション ツリーのコントロール ビューに常に含まれます。 |
| UIA_IsKeyboardFocusablePropertyId | 「ノート」を参照してください。 | コントロールがキーボード フォーカスを受け取ることができる場合は、このプロパティをサポートする必要があります。 |
| UIA_LabeledByPropertyId | 「ノート」を参照してください。 | このプロパティの値は、ドキュメント コントロールのラベルでなければなりません。 通常、ドキュメントのタイトルが使用されます。 |
| UIA_LocalizedControlTypePropertyId | 「ノート」を参照してください。 | Document コントロールの種類に対応するローカライズされた文字列。 既定値は、en-US または英語 (米国) の "document" です。 |
| UIA_NamePropertyId | 「ノート」を参照してください。 | ドキュメント コントロールは、通常、読み込み元のファイル名から名前を取得します。 この名前は多くの場合、そのコントロールを格納するウィンドウまたはフレームのタイトルに表示されます。 |
必須のコントロール パターン
次の表に、ドキュメント コントロールでサポートされる必要がある UI オートメーション コントロール パターンを示します。 コントロール パターンの詳細については、「 UI Automation Control Patterns Overview」を参照してください。
| コントロール パターン/パターン プロパティ | サポート/値 | メモ |
|---|---|---|
| IScrollProvider | 依存 | ドキュメント コントロールは、ビューポートのスパンを超えてスパンできます。 コンテンツがスクロール可能な場合、コントロールは スクロール コントロール パターンをサポートする必要があります。 |
| ITextProvider | 必須 | すべてのドキュメント コントロールで Text コントロール パターンがサポートされている必要があります。 |
| IValueProvider | 依存 | UI オートメーションクライアントは IUIAutomationTextPattern を使用してドキュメントに関するテキスト情報を取得できますが、内部値を設定するには Value コントロール パターンが必要です。 単純なテキスト入力は、Value コントロール パターンでのみ可能です。 |
必須イベント
次の表に、ドキュメント コントロールがサポートするために必要なUI オートメーション イベントの一覧を示します。 イベントの詳細については、「 UI Automation Events Overview」を参照してください。
| UI オートメーション イベント | メモ |
|---|---|
| UIA_AutomationFocusChangedEventId | |
| プロパティ変更イベントUIA_BoundingRectanglePropertyId 。 | |
| プロパティ変更イベントUIA_IsEnabledPropertyId。 | コントロールが IsEnabled プロパティをサポートしている場合は、このイベントをサポートする必要があります。 |
| プロパティ変更イベントUIA_IsOffscreenPropertyId。 | コントロールが IsOffscreen プロパティをサポートしている場合は、このイベントをサポートする必要があります。 |
| UIA_StructureChangedEventId | |
| プロパティ変更イベントUIA_ScrollHorizontallyScrollablePropertyIdします。 | コントロールが スクロール コントロール パターンをサポートしている場合は、このイベントをサポートする必要があります。 |
| プロパティ変更イベントUIA_ScrollHorizontalScrollPercentPropertyIdします。 | コントロールが スクロール コントロール パターンをサポートしている場合は、このイベントをサポートする必要があります。 |
| プロパティ変更イベントUIA_ScrollHorizontalViewSizePropertyIdします。 | コントロールが スクロール コントロール パターンをサポートしている場合は、このイベントをサポートする必要があります。 |
| プロパティ変更イベントUIA_ScrollVerticallyScrollablePropertyIdします。 | コントロールが スクロール コントロール パターンをサポートしている場合は、このイベントをサポートする必要があります。 |
| プロパティ変更イベントUIA_ScrollVerticalScrollPercentPropertyIdします。 | コントロールが スクロール コントロール パターンをサポートしている場合は、このイベントをサポートする必要があります。 |
| プロパティ変更イベントUIA_ScrollVerticalViewSizePropertyId します。 | コントロールが スクロール コントロール パターンをサポートしている場合は、このイベントをサポートする必要があります。 |
| UIA_Selection_InvalidatedEventId | コントロールが Selection コントロール パターンをサポートしている場合は、このイベントをサポートする必要があります。 |
| UIA_Text_TextSelectionChangedEventId | |
| UIA_Text_TextChangedEventId | |
| プロパティ変更イベントUIA_ValueValuePropertyId。 | コントロールが Value コントロール パターンをサポートしている場合は、このイベントをサポートする必要があります。 |
関連トピック