activate()

方法描述

激活窗口

調用樣例- rpa.ui.win32.Window.activate-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.activate()

maximize()

方法描述

最大化窗口

調用樣例- rpa.ui.win32.Window.maximize-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.maximize()

minimize()

方法描述

最小化窗口

調用樣例- rpa.ui.win32.Window.minimize-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.minimize()

hide()

方法描述

隱藏窗口

調用樣例- rpa.ui.win32.Window.hide-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.hide()

show()

方法描述

窗口顯示

調用樣例- rpa.ui.win32.Window.show-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.show()

wait_disappear(timeout=30)

方法描述

等待窗口消失

參數說明

timeout<int>超時時間

調用樣例- rpa.ui.win32.Window.wait_disappear-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.wait_disappear()

close()

方法描述

關閉窗口

調用樣例- rpa.ui.win32.Window.close-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.close()

get_element_by_name(element, index=1, parent_element=None, timeout=10)

方法描述

根據控件名獲取控件對象

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回控件對象<Element>

調用樣例- rpa.ui.win32.Window.get_element_by_name-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
ele = wnd.get_element_by_name("記事本輸入框")

count(element, parent_element=None)

方法描述

獲取控件個數

參數說明

element<str>控件名

parent_element<Element>父控件對象

返回值說明

返回控件個數<int>

調用樣例- rpa.ui.win32.Window.count-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
ele_count = wnd.count("記事本輸入框")

wait_loaded(element, index=1, parent_element=None, timeout=10)

方法描述

等待加載控件，成功返回True，失敗返回False

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回是否加載成功<bool>

調用樣例- rpa.ui.win32.Window.wait_loaded-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.wait_loaded("記事本輸入框")

input_text(element, value, index=1, parent_element=None, simulate=False, replace=True, send_window_message=True, sent_raw=False, wait_mili_seconds=20, timeout=10)

方法描述

向控件中輸入文本

參數說明

element<str>控件名

value<str>輸入的內容

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

simulate<bool>是否模擬輸入

replace<bool>是否清空之前的內容

send_window_message<bool>是否發送Windows消息，僅非模擬模式有效

sent_raw<bool>是否發送原始按鍵，僅非模擬模式有效

wait_mili_seconds<int>字符間輸入間隔（毫秒），僅在模擬輸入下有效，默認值為20，最大值100，該值設置過大可能會引起超時

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.input_text-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.input_text("記事本輸入框", "測試一下")

input_hotkeys(element, value, replace=False, index=1, parent_element=None, timeout=10)

方法描述

向控件輸入快捷鍵

參數說明

element<str>控件名

value<str>輸入的內容

replace<bool>是否清空之前的內容

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.input_hotkeys-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.input_hotkeys("記事本輸入框", "VK_BACK")

drive_input(element, value, replace=True, index=1, parent_element=None, wait_mili_seconds=20, timeout=10)

方法描述

以驅動輸入的方式向控件中輸入文本

參數說明

element<str>控件名

value<str>輸入的內容

replace<bool>是否清空之前的內容

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

wait_mili_seconds<int>字符間輸入間隔（毫秒），僅在模擬輸入下有效，默認值為20，最大值100，該值設置過大可能會引起超時

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.drive_input-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.drive_input("記事本輸入框", "RpaTest")

click(element, button='left', simulate=True, offset_x=0, offset_y=0, index=1, parent_element=None, timeout=10)

方法描述

點擊控件，默認點擊控件中心，可通過設定偏移量點擊指定位置

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

simulate<bool>是否模擬點擊

offset_x<int>橫向偏移量

offset_y<int>縱向偏移量

button<str>鼠標鍵位

可選項：

• left : 左鍵

• right : 右鍵

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.click-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.click("記事本輸入框")

double_click(element, offset_x=0, offset_y=0, index=1, parent_element=None, simulate=True, timeout=10)

方法描述

雙擊控件，默認雙擊控件中心，可通過設定偏移量雙擊指定位置

參數說明

element<str>控件名

offset_x<int>橫向偏移量

offset_y<int>縱向偏移量

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

simulate<bool>是否模擬點擊

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.double_click-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.double_click("記事本輸入框")

expand(element, index=1, parent_element=None, timeout=10)

方法描述

控件展開節點

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.expand-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.expand("控件名稱")

collapse(element, index=1, parent_element=None, timeout=10)

方法描述

控件折疊節點

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間

調用樣例- rpa.ui.win32.Window.collapse-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.collapse("控件名稱")

set_selected_item_by_text(element, text, index=1, parent_element=None, timeout=10)

方法描述

combobox--根據指定文本選中下拉列表中的項

參數說明

element<str>控件名

text<str>選項文本

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.set_selected_item_by_text-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.set_selected_item_by_text("控件名稱", "選擇內容")

set_selected_item_by_index(element, item_index, index=1, parent_element=None, timeout=10)

方法描述

combobox--根據指定下標選中下拉列表中的項

參數說明

element<str>控件名

item_index<int>選項下標

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.set_selected_item_by_index-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.set_selected_item_by_index("控件名稱", "要選擇內容的序號")

get_selected_items(element, mode='selected', index=1, parent_element=None, timeout=10)

方法描述

獲取combobox的所有選項或者所有選中的選項

參數說明

element<str>控件名

mode<str>選擇模式

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回選項的數組<list>

調用樣例- rpa.ui.win32.Window.get_selected_items-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
selected_items = wnd.get_selected_items("控件名稱")

set_checked_state(element, value=True, index=1, parent_element=None, timeout=10)

方法描述

設置復選框狀態

參數說明

element<str>控件名

value<bool>是否勾選

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.set_checked_state-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.set_checked_state("控件名稱", value=True)

get_checked_state(element, index=1, parent_element=None, timeout=10)

方法描述

獲取復選框狀態

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回復選框的狀態<bool>

調用樣例- rpa.ui.win32.Window.get_checked_state-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
checked_state = wnd.get_checked_state("控件名稱")

get_selected(element, index=1, parent_element=None, timeout=10)

方法描述

獲取選中狀態

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回是否選中<bool>

調用樣例- rpa.ui.win32.Window.get_selected-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
checked_state = wnd.get_selected("控件名稱")

text(element, index=1, parent_element=None, timeout=10)

方法描述

獲取控件中的文本

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回文本<str>

調用樣例- rpa.ui.win32.Window.text-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
text = wnd.text("控件名稱")

pos(element, index=1, parent_element=None, timeout=10)

方法描述

獲取控件的坐標

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回坐標{x1,y1,x2,y2}<dict>

調用樣例- rpa.ui.win32.Window.pos-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
pos = wnd.pos("控件名稱")

table(element, index=1, parent_element=None, timeout=10)

方法描述

獲取控件表格內容

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回表格內容<list>

調用樣例- rpa.ui.win32.Window.table-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
table_list = wnd.table("控件名稱")

scroll(element, percent, direction='top', index=1, parent_element=None, timeout=10)

方法描述

將滾動條滾動到指定位置（位置范圍0-100）,由于windows系統底層接口問題，設置的值可能會和實際值存在正負1%的偏差

參數說明

element<str>控件名

percent<int/float>滾動百分比

可選項：

• top : 向上滾動

• left : 向下滾動

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.scroll-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.scroll("控件名稱", 50)

get_horizontal_scroll_percent(element, index=1, parent_element=None, timeout=10)

方法描述

獲取橫向滾動條位置（位置范圍0-100）

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回橫向滾動條位置<float>

調用樣例- rpa.ui.win32.Window.get_horizontal_scroll_percent-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
horizontal_scroll_percent = wnd.get_horizontal_scroll_percent("控件名稱")

get_vertical_scroll_percent(element, index=1, parent_element=None, timeout=10)

方法描述

獲取縱向滾動條位置（位置范圍0-100）

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

返回值說明

返回縱向滾動條位置<float>

調用樣例- rpa.ui.win32.Window.get_vertical_scroll_percent-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
horizontal_scroll_percent = wnd.get_vertical_scroll_percent("控件名稱")

screenshot(element, file, index=1, parent_element=None, timeout=10)

方法描述

控件截圖

參數說明

element<str>控件名

file<str>保存截圖完成路徑（含文件名）

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.screenshot-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.screenshot("控件名稱", "d:\1.png")

mouse_move(element, index=1, parent_element=None, timeout=10)

方法描述

鼠標移入控件

參數說明

element<str>控件名

index<int>如果有多個，給出控件下標

parent_element<Element>父控件對象

timeout<int>等待控件超時時間，單位秒

調用樣例- rpa.ui.win32.Window.mouse_move-

# 注意事項：無
# 代碼調用樣例如下：
wnd = rpa.ui.win32.catch("記事本", mode="substr")
wnd.mouse_move("控件名稱")