uiautomationcoreapi.h 标头

Windows 辅助功能使用此标头。 有关详细信息，请参阅：

• Windows 辅助功能

uiautomationcoreapi.h 包含以下编程接口：

函数

DockPattern_SetDockPosition 将 UI 自动化元素停靠在停靠容器中请求的 dockPosition 处。
ExpandCollapsePattern_Collapse 隐藏 UI 自动化元素的所有后代节点、控件或内容。
ExpandCollapsePattern_Expand 展开屏幕上的控件，使其显示详细信息。
GridPattern_GetItem 获取网格中项的节点。
InvokePattern_Invoke 发送请求以激活控件并启动其单一、明确的操作。 (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 通过突出显示与调用文本范围“开始”和“结束”终结点对应的补充文本，将添加到支持多个不连续选择的文本容器中的突出显示文本的现有集合。
TextRange_Clone 复制文本范围。
TextRange_Compare 比较两个文本范围。
TextRange_CompareEndpoints 返回一个值，该值指示两个文本范围是否具有相同的终结点。
TextRange_ExpandToEnclosingUnit 将文本范围扩展到更大或更小的单位，例如 Character、Word、Line 或 Page。
TextRange_FindAttribute 在指定方向搜索支持指定文本属性的第一段文本。
TextRange_FindText 返回指定方向包含客户端要搜索的文本的第一个文本范围。
TextRange_GetAttributeValue 获取文本范围的文本属性的值。
TextRange_GetBoundingRectangles 检索可以包围该区域的最小边界矩形数，每行一个矩形。
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 检索一个或多个与搜索条件匹配的 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 自动化核心文本控件已以编程方式更改文本。 (UiaRaiseActiveTextPositionChangedEvent)
UiaRaiseAsyncContentLoadedEvent 由提供程序调用，以通知 Microsoft UI 自动化核心正在异步加载内容。
UiaRaiseAutomationEvent 通知侦听器事件。
UiaRaiseAutomationPropertyChangedEvent 由提供程序调用，以通知 Microsoft UI 自动化核心元素属性已更改。
UiaRaiseChangesEvent 由提供程序调用，以通知 Microsoft UI 自动化核心发生了更改。
UiaRaiseNotificationEvent 由提供程序调用以启动通知事件。
UiaRaiseStructureChangedEvent 由提供程序调用，以通知 Microsoft UI 自动化核心树结构已更改。
UiaRaiseTextEditTextChangedEvent 由提供程序调用，以通知 Microsoft UI 自动化核心文本控件已以编程方式更改文本。 (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 注意 此结构已弃用。  包含有关在一个或多个窗口关闭时引发的事件的信息。

枚举

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) 枚举定义可用于自定义树导航顺序的值。