uiautomationcoreapi.h ヘッダー
このヘッダーは、Windows アクセシビリティ機能で使用されます。 詳細については、次を参照してください。
uiautomationcoreapi.h には、次のプログラミング インターフェイスが含まれています。
関数
| DockPattern_SetDockPosition ドッキング コンテナー内の要求された dockPosition に UI オートメーション要素をドッキングします。 |
| ExpandCollapsePattern_Collapse UI オートメーション要素のすべての子孫ノード、コントロール、またはコンテンツを非表示にします。 |
| ExpandCollapsePattern_Expand 画面上のコントロールを展開して、詳細情報を表示します。 |
| GridPattern_GetItem グリッド内の項目のノードを取得します。 |
| InvokePattern_Invoke 要求を送信してコントロールをアクティブ化し、その 1 つの明確なアクションを開始します。 (InvokePattern_Invoke) |
| ItemContainerPattern_FindItemByProperty 指定したプロパティ値に基づいて、含まれているノード内のノードを取得します。 |
| LegacyIAccessiblePattern_DoDefaultAction 要素に対して Microsoft Active Accessibility の既定のアクションを実行します。 (LegacyIAccessiblePattern_DoDefaultAction) |
| LegacyIAccessiblePattern_GetIAccessible UI オートメーション要素に対応する IAccessible オブジェクトを取得します。 |
| LegacyIAccessiblePattern_Select Microsoft Active Accessibility の選択を実行します。 (LegacyIAccessiblePattern_Select) |
| LegacyIAccessiblePattern_SetValue ノードの Microsoft Active Accessibility 値プロパティを設定します。 |
| MultipleViewPattern_GetViewName コントロール固有のビューの名前を取得します。 (MultipleViewPattern_GetViewName) |
| MultipleViewPattern_SetCurrentView コントロールを別のレイアウトに設定します。 |
| RangeValuePattern_SetValue 数値範囲を持つコントロールの値を設定します。 |
| ScrollItemPattern_ScrollIntoView コンテナーの可視領域 (ビューポート) 内に UI オートメーション要素を表示するために、コンテナー オブジェクトのコンテンツ領域をスクロールします。 |
| ScrollPattern_Scroll 指定した ScrollAmount、水平方向、垂直方向、またはその両方のコンテンツ領域の現在表示されている領域をスクロールします。 |
| ScrollPattern_SetScrollPercent コンテナーを水平方向、垂直方向、またはその両方の特定の位置までスクロールします。 |
| SelectionItemPattern_AddToSelection 選択されていない要素をコントロール内の選択範囲に追加します。 |
| SelectionItemPattern_RemoveFromSelection 選択コンテナー内の選択範囲から要素を削除します。 |
| SelectionItemPattern_Select 選択コンテナー内の要素を選択します。 |
| SynchronizedInputPattern_Cancel UI オートメーション プロバイダーがマウスまたはキーボード入力のリッスンを停止します。 |
| SynchronizedInputPattern_StartListening UI オートメーション プロバイダーがマウスまたはキーボード入力のリッスンを開始します。 |
| TextPattern_get_DocumentRange 文書全体のテキスト範囲を取得します。 |
| TextPattern_get_SupportedTextSelection テキスト コンテナーの内容を選択および選択解除できるかどうかを確認します。 |
| TextPattern_GetSelection テキスト パターンをサポートするテキスト コンテナーから選択したテキストの現在の範囲を取得します。 |
| TextPattern_GetVisibleRanges テキスト コンテナーから非結合テキスト範囲の配列を取得します。それぞれのテキスト範囲は部分的に表示されている最初の行から始まり、部分的に表示されている最後の行の末尾で終わります。 |
| TextPattern_RangeFromChild 特定のノードにまたがるテキスト範囲を取得します。 |
| TextPattern_RangeFromPoint 指定した画面座標に最も近い、縮退した (空の) テキスト範囲を取得します。 (TextPattern_RangeFromPoint) |
| TextRange_AddToSelection 呼び出し元のテキスト範囲の Start エンドポイントと End エンドポイントに対応する補助テキストを強調表示することで、複数の不整合な選択をサポートするテキスト コンテナー内の強調表示されたテキストの既存のコレクションに追加します。 |
| TextRange_Clone テキスト範囲をコピーします。 |
| TextRange_Compare 2 つのテキスト範囲を比較します。 |
| TextRange_CompareEndpoints 2 つのテキスト範囲に同じエンドポイントがあるかどうかを示す値を返します。 |
| TextRange_ExpandToEnclosingUnit 文字、Word、行、ページなどの大小の単位にテキスト範囲を展開します。 |
| TextRange_FindAttribute 指定した方向で、指定したテキスト属性をサポートするテキストの最初の部分を検索します。 |
| TextRange_FindText クライアントが検索しているテキストを含む、指定した方向の最初のテキスト範囲を返します。 |
| TextRange_GetAttributeValue テキスト範囲のテキスト属性の値を取得します。 |
| TextRange_GetBoundingRectangles 範囲を囲むことができる外接する四角形の最小数 (1 行に 1 つの四角形) を取得します。 |
| TextRange_GetChildren 指定したテキスト範囲内に含まれるすべての UI オートメーション要素を返します。 |
| TextRange_GetEnclosingElement 範囲をカバーする次に小さいプロバイダーのノードを返します。 |
| TextRange_GetText 指定した文字数までのテキスト範囲内のテキストを返します。 |
| TextRange_Move クライアントによって要求された指定された単位数のテキスト範囲を移動します。 |
| TextRange_MoveEndpointByRange ある範囲のエンドポイントを別の範囲のエンドポイントに移動します。 |
| TextRange_MoveEndpointByUnit 指定した単位数の範囲のエンドポイントを移動します。 |
| TextRange_RemoveFromSelection 複数の不整合な選択をサポートするテキスト コンテナー内の選択したテキストの既存のコレクションから、呼び出し元のテキスト範囲TextPatternRangeEndpoint_StartおよびTextPatternRangeEndpoint_Endエンドポイントに対応する選択したテキストを削除します。 |
| TextRange_ScrollIntoView 指定した範囲がビューポートに表示されるようにテキストをスクロールします。 |
| TextRange_Select テキスト範囲を選択します。 |
| TogglePattern_Toggle コントロールを次にサポートされている状態に切り替えます。 |
| TransformPattern_Move 画面上の指定した場所に要素を移動します。 |
| TransformPattern_Resize 画面上の要素のサイズを変更します。 |
| TransformPattern_Rotate 画面上の要素を回転させます。 |
| UiaAddEvent UI オートメーション ツリー内のノード上のイベントのリスナーを追加します。 |
| UiaClientsAreListening クライアント アプリケーションが Microsoft UI オートメーション イベントにサブスクライブされているかどうかを示す値を取得します。 |
| UiaDisconnectAllProviders 呼び出し元プロセスに関連付けられているすべてのプロバイダーによって保持されているすべての Microsoft UI オートメーション リソースを解放します。 |
| UiaDisconnectProvider 特定のプロバイダーが保持するすべての参照を Microsoft UI オートメーション オブジェクトに解放します。 |
| UiaEventAddWindow イベント リスナーにウィンドウを追加します。 |
| UiaEventRemoveWindow イベント リスナーからウィンドウを削除します。 |
| UiaFind 検索条件に一致する 1 つ以上の UI オートメーション ノードを取得します。 |
| UiaGetErrorDescription クライアントに渡すことができるようにエラー文字列を取得します。 このメソッドは、クライアントによって直接使用されません。 |
| UiaGetPatternProvider コントロール パターンを取得します。 |
| UiaGetPropertyValue UI オートメーション プロパティの値を取得します。 |
| UiaGetReservedMixedAttributeValue Microsoft UI オートメーション テキスト属性の値がテキスト範囲内で変化することを示す予約値を取得します。 |
| UiaGetReservedNotSupportedValue Microsoft UI オートメーション プロパティまたはテキスト属性がサポートされていないことを示す予約値を取得します。 |
| UiaGetRootNode ルート UI オートメーション ノードを取得します。 |
| UiaGetRuntimeId UI オートメーション ノードのランタイム識別子を取得します。 |
| UiaGetUpdatedCache プロパティ値とコントロール パターンのキャッシュを更新します。 |
| UiaHasServerSideProvider ウィンドウに Microsoft UI オートメーション プロバイダーの実装があるかどうかを確認します。 |
| UiaHostProviderFromHwnd ウィンドウのホスト プロバイダーを取得します。 |
| UiaHPatternObjectFromVariant VARIANT 型からコントロール パターン オブジェクトを取得します。 |
| UiaHTextRangeFromVariant VARIANT 型からテキスト範囲を取得します。 |
| UiaHUiaNodeFromVariant VARIANT 型から HUIANODE を取得します。 |
| UiaIAccessibleFromProvider Microsoft UI オートメーション プロバイダーの代わりに Microsoft Active Accessibility データを提供する IAccessible 実装を取得します。 |
| UiaLookupId PROPERTYID、PATTERNID、CONTROLTYPEID、TEXTATTRIBUTEID、または EVENTID を必要とするメソッドで使用できる整数識別子を取得します。 |
| UiaNavigate UI オートメーション ツリー内を移動し、必要に応じてキャッシュされた情報を取得します。 |
| UiaNodeFromFocus 現在入力フォーカスがある UI 要素の UI オートメーション ノードを取得します。 |
| UiaNodeFromHandle ウィンドウに関連付けられている UI オートメーション ノードを取得します。 |
| UiaNodeFromPoint 指定したポイントにある要素の UI オートメーション ノードを取得します。 |
| UiaNodeFromProvider 生要素プロバイダーの UI オートメーション ノードを取得します。 |
| UiaNodeRelease メモリからノードを削除します。 |
| UiaPatternRelease 割り当てられたパターン オブジェクトをメモリから削除します。 |
| UiaProviderForNonClient ウィンドウのクライアント以外の領域全体、またはウィンドウのクライアント以外の領域のコントロールのプロバイダーを取得します。 |
| UiaProviderFromIAccessible 指定した Microsoft Active Accessibility オブジェクトに基づいて Microsoft UI オートメーション プロバイダーを作成します。 |
| UiaRaiseActiveTextPositionChangedEvent テキスト コントロールがプログラムによってテキストを変更したことを Microsoft UI Automation コアに通知するために、プロバイダーによって呼び出されます。 (UiaRaiseActiveTextPositionChangedEvent) |
| UiaRaiseAsyncContentLoadedEvent コンテンツが非同期的に読み込まれていることを Microsoft UI Automation コアに通知するために、プロバイダーによって呼び出されます。 |
| UiaRaiseAutomationEvent イベントをリスナーに通知します。 |
| UiaRaiseAutomationPropertyChangedEvent 要素プロパティが変更されたことを Microsoft UI オートメーション コアに通知するために、プロバイダーによって呼び出されます。 |
| UiaRaiseChangesEvent 変更が発生したことを Microsoft UI オートメーション コアに通知するためにプロバイダーによって呼び出されます。 |
| UiaRaiseNotificationEvent 通知イベントを開始するためにプロバイダーによって呼び出されます。 |
| UiaRaiseStructureChangedEvent ツリー構造が変更されたことを Microsoft UI Automation コアに通知するためにプロバイダーによって呼び出されます。 |
| UiaRaiseTextEditTextChangedEvent テキスト コントロールがプログラムによってテキストを変更したことを Microsoft UI Automation コアに通知するために、プロバイダーによって呼び出されます。 (UiaRaiseTextEditTextChangedEvent) |
| UiaRectIsEmpty 四角形の座標がすべて 0 に設定されているかどうかを示すブール値を取得します。 |
| UiaRectSetEmpty UiaRect 構造体の要素を 0 に設定します。 |
| UiaRegisterProviderCallback 要素のプロバイダーを取得するために UI オートメーションによって呼び出されるアプリケーション定義メソッドを登録します。 |
| UiaRemoveEvent UI オートメーション ツリー内のノード上のイベントのリスナーを削除します。 |
| UiaReturnRawElementProvider ウィンドウの UI オートメーション プロバイダーへのインターフェイスを取得します。 |
| UiaSetFocus UI の指定した要素に入力フォーカスを設定します。 |
| UiaTextRangeRelease 割り当てられたテキスト範囲オブジェクトをメモリから削除します。 |
| ValuePattern_SetValue 要素のテキスト値を設定します。 |
| VirtualizedItemPattern_Realize 仮想項目に UI オートメーション要素として全面的にアクセスできるようにします。 (VirtualizedItemPattern_Realize) |
| WindowPattern_Close 開いているウィンドウを閉じます。 |
| WindowPattern_SetWindowVisualState ウィンドウの表示状態を設定します。たとえば、ウィンドウを最大化します。 |
| WindowPattern_WaitForInputIdle 呼び出し元のコードは、指定された時間、または関連付けられたプロセスがアイドル状態に入るまでブロックされます。どちらが最初に完了するかは関係ありません。 (WindowPattern_WaitForInputIdle) |
コールバック関数
| UiaEventCallback クライアントがサブスクライブしたイベントが発生したときに UI オートメーションによって呼び出されるクライアント実装関数。 |
| UiaProviderCallback 要素のクライアント側プロバイダーを取得するために UI オートメーションによって呼び出されるアプリケーション定義関数。 |
構造
| UiaAndOrCondition メモ この構造体は非推奨です。 複雑な条件に関する情報が含まれます。 |
| UiaAsyncContentLoadedEventArgs メモ この構造体は非推奨です。 コンテンツが UI 要素によって非同期に読み込まれるときに発生するイベントに関する情報を格納します。 |
| UiaCacheRequest メモ この構造体は非推奨です。 UI オートメーション要素に関するデータをキャッシュする要求に関する情報が含まれます。 |
| UiaCondition メモ この構造体は非推奨です。 条件に関する情報を格納します。 |
| UiaEventArgs メモ この構造体は非推奨です。 Microsoft UI オートメーション イベントに関する情報が含まれます。 |
| UiaFindParams メモ この構造体は非推奨です。 UiaFind 関数で使用されるパラメーターを格納します。 |
| UiaNotCondition メモ この構造体は非推奨です。 負の条件に関する情報が含まれます。 |
| UiaPropertyChangedEventArgs メモ この構造体は非推奨です。 Microsoft UI オートメーション要素のプロパティの変更が発生したときに発生するイベントに関する情報が含まれます。 |
| UiaPropertyCondition メモ この構造体は非推奨です。 一致するプロパティを持つ UI オートメーション要素を検索するために使用される条件に関する情報が含まれます。 |
| UiaStructureChangedEventArgs メモ この構造体は非推奨です。 Microsoft UI オートメーション ツリーの構造が変更されたときに発生するイベントに関する情報が含まれます。 |
| UiaWindowClosedEventArgs メモ この構造体は非推奨です。 1 つ以上のウィンドウが閉じるときに発生するイベントに関する情報を格納します。 |
列挙
| AsyncContentLoadedState コンテンツの非同期読み込みの進行状況を表す値が含まれます。 |
| AutomationElementMode AutomationElementMode (uiautomationcoreapi.h) 列挙には、UI オートメーション要素を返すときに使用する参照の種類を指定する値が含まれています。 |
| AutomationIdentifierType UiaLookupId 関数で使用される値を格納します。 |
| ConditionType UiaCondition の種類を指定する値を格納します。 |
| EventArgsType UiaEventArgs 構造体によって記述されるイベントの種類を指定する値を格納します。 |
| NormalizeState UiaGetUpdatedCache の動作を指定する値を格納します。 |
| PropertyConditionFlags PropertyConditionFlags (uiautomationcoreapi.h) 列挙には、プロパティ条件の作成に使用される値が含まれています。 |
| ProviderType クライアント側 (プロキシ) UI オートメーション プロバイダーの種類を指定する値を格納します。 |
| TreeScope TreeScope (uiautomationcoreapi.h) 列挙には、Microsoft UI オートメーション ツリーのさまざまな操作のスコープを指定する値が含まれています。 |
| TreeTraversalOptions TreeTraversalOptions (uiautomationcoreapi.h) 列挙は、ツリー ナビゲーション順序のカスタマイズに使用できる値を定義します。 |