uiautomationcoreapi.h 標頭
Windows 協助工具功能會使用此標頭。 如需詳細資訊,請參閱:
uiautomationcoreapi.h 包含下列程式設計介面:
函式
DockPattern_SetDockPosition 將 UI 自動化元素停駐在停駐容器內要求的 dockPosition。 |
ExpandCollapsePattern_Collapse 隱藏使用者介面自動化專案的所有子代節點、控制項或內容。 |
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 Automation 元素, (檢視區) 。 |
ScrollPattern_Scroll 捲動指定 ScrollAmount、水準、垂直或兩者的內容區域目前可見區域。 |
ScrollPattern_SetScrollPercent 將容器水準、垂直或兩者捲動至特定位置。 |
SelectionItemPattern_AddToSelection 將未選取的專案加入至 控制項中的選取範圍。 |
SelectionItemPattern_RemoveFromSelection 從選取範圍容器中的選取範圍中移除專案。 |
SelectionItemPattern_Select 選取選取容器中的專案。 |
SynchronizedInputPattern_Cancel 導致使用者介面自動化提供者停止接聽滑鼠或鍵盤輸入。 |
SynchronizedInputPattern_StartListening 導致使用者介面自動化提供者開始接聽滑鼠或鍵盤輸入。 |
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 傳回包含在指定文字範圍內的所有使用者介面自動化專案。 |
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 擷取 IAccessible 實作,代表 Microsoft UI 自動化提供者提供 Microsoft Active Accessibility 資料。 |
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 註冊使用者介面自動化所呼叫的應用程式定義方法,以取得專案的提供者。 |
UiaRemoveEvent 移除 UI 自動化樹狀結構中節點上事件的接聽程式。 |
UiaReturnRawElementProvider 取得視窗 UI 自動化提供者的介面。 |
UiaSetFocus 將輸入焦點設定為 UI 中的指定專案。 |
UiaTextRangeRelease 從記憶體中刪除配置的文字範圍物件。 |
ValuePattern_SetValue 設定專案的文字值。 |
VirtualizedItemPattern_Realize 允許將虛擬項目當做使用者介面自動化項目完整存取。 (VirtualizedItemPattern_Realize) |
WindowPattern_Close 關閉開啟的視窗。 |
WindowPattern_SetWindowVisualState 設定視窗的視覺狀態;例如,若要最大化視窗。 |
WindowPattern_WaitForInputIdle 導致將呼叫程式碼封鎖指定的時間,或直到相關聯的處理序進入閒置狀態 (就看何者先完成)。 (WindowPattern_WaitForInputIdle) |
回呼函式
UiaEventCallback 用戶端實作的函式,會在引發用戶端已訂閱的事件時由使用者介面自動化呼叫。 |
UiaProviderCallback 由使用者介面自動化呼叫的應用程式定義函式,可取得專案的用戶端提供者。 |
結構
UiaAndOrCondition 注意 此結構已被取代。 包含複雜條件的相關資訊。 |
UiaAsyncContentLoadedEventArgs 注意 此結構已被取代。 包含 UI 元素以非同步方式載入內容時所引發事件的相關資訊。 |
UiaCacheRequest 注意 此結構已被取代。 包含快取使用者介面自動化專案相關資料之要求的相關資訊。 |
UiaCondition 注意 此結構已被取代。 包含條件的相關資訊。 |
UiaEventArgs 注意 此結構已被取代。 包含 Microsoft UI 自動化事件的相關資訊。 |
UiaFindParams 注意 此結構已被取代。 包含 UiaFind 函式中使用的參數。 |
UiaNotCondition 注意 此結構已被取代。 包含負條件的相關資訊。 |
UiaPropertyChangedEventArgs 注意 此結構已被取代。 包含發生 Microsoft UI Automation 元素屬性變更時所引發之事件的相關資訊。 |
UiaPropertyCondition 注意 此結構已被取代。 包含用來尋找具有相符屬性之使用者介面自動化專案之條件的相關資訊。 |
UiaStructureChangedEventArgs 注意 此結構已被取代。 包含 Microsoft UI 自動化樹狀結構變更時所引發之事件的相關資訊。 |
UiaWindowClosedEventArgs 注意 此結構已被取代。 包含一或多個視窗關閉時所引發之事件的相關資訊。 |
列舉
AsyncContentLoadedState 包含值,描述非同步載入內容的進度。 |
AutomationElementMode AutomationElementMode (uiautomationcoreapi.h) 列舉包含值,指定傳回 UI 自動化元素時要使用的參考類型。 |
AutomationIdentifierType 包含 UiaLookupId 函式中使用的值。 |
ConditionType 包含指定 UiaCondition 類型的值。 |
EventArgsType 包含值,指定 UiaEventArgs 結構所描述的事件種類。 |
NormalizeState 包含值,指定 UiaGetUpdatedCache 的行為。 |
PropertyConditionFlags PropertyConditionFlags (uiautomationcoreapi.h) 列舉包含用來建立屬性條件的值。 |
ProviderType 包含值,指定用戶端 (Proxy) UI 自動化提供者的類型。 |
TreeScope TreeScope (uiautomationcoreapi.h) 列舉包含的值,指定 Microsoft UI 自動化樹狀結構中各種作業的範圍。 |
TreeTraversalOptions TreeTraversalOptions (uiautomationcoreapi.h) 列舉會定義可用來自訂樹狀目錄導覽順序的值。 |