xbot.win32.Window
この記事の内容
win32ウィンドウに対して、アクティブ化、最大化/最小化、表示/非表示などの各種操作を行います
メソッド
get_detail()
ウィンドウの詳細情報を取得します
get_detail(self, operation)
入力パラメータ
- operation:取得するウィンドウ情報を指定します。'title'(ウィンドウタイトル)、'text'(ウィンドウの内容)、'process_name'(ウィンドウのプロセス名)を選択できます
戻り値
str:ウィンドウ情報を返します
例1
from xbot import win32
def main(args):
wnd = win32.get_by_handle(0x01402c)
title = wnd.get_detail('title')
print(title)
この例の実行内容: ハンドルが 0x01402c のwin32ウィンドウのタイトル情報を取得します --> タイトル情報を出力します
activate()
ウィンドウをアクティブにします
activate(self)
入力パラメータ
なし
戻り値
なし
例1
from xbot import win32
def main(args):
wnd = win32.get_by_handle(0x01402c)
wnd.activate()
この例の実行内容: ハンドルが 0x01402c のwin32ウィンドウを取得します --> そのウィンドウをアクティブにします
set_state()
ウィンドウの表示状態を変更します
set_state(self, flag)
入力パラメータ
flag:ウィンドウの操作を指定します。'hide'(非表示)、'show'(表示)、'minimize'(最小化)、'maximize'(最大化)、'restore'(元のサイズ)を設定できます
戻り値
なし
例1
from xbot import win32
def main(args):
wnd = win32.get('新建文本')
wnd.set_state('minimize')
この例の実行内容: ウィンドウタイトルが 新建文本 のウィンドウを最小化します
move()
ウィンドウを指定位置に移動します
move(self, x=0, y=0)
入力パラメータ
x:指定位置の横座標です。デフォルト値は0です
y:指定位置の縦座標です。デフォルト値は0です
戻り値
なし
例1
from xbot import win32
def main(args):
wnd = win32.get('新建文本')
wnd.move(x=100, y=100)
この例の実行内容: ウィンドウタイトルが 新建为本 のウィンドウを x=100、y=100 の位置に移動します
resize()
ウィンドウのサイズを設定します
resize(self, width=1, height=1)
入力パラメータ
width:ウィンドウの幅(px)です。デフォルトの幅は1です
height:ウィンドウの高さ(px)です。デフォルトの高さは1です
戻り値
なし
例1
from xbot import win32
def main(args):
wnd = win32.get('新建文本')
wnd.resize(width=100, height=100)
この例の実行内容: ウィンドウタイトルが 新建文本 のウィンドウの幅(px)を 100、高さ(px)を 100 に設定します
close()
ウィンドウを閉じます
close(self)
入力パラメータ
なし
戻り値
なし
例1
from xbot import win32
def main(args):
wnd = win32.get('新建文本')
wnd.close()
この例の実行内容: ウィンドウタイトルが 新建文本 のウィンドウを閉じます
is_active()
ウィンドウが選択されている(アクティブである)かどうかを判定します
is_active(self)
入力パラメータ
なし
戻り値
bool:現在のウィンドウが選択されているかどうかを返します。選択されている場合はTrue、選択されていない場合はFalseを返します
例1
from xbot import win32
def main(args):
wnd = win32.get_by_handle(0x01402c)
is_active = wnd.is_active()
この例の実行内容: ハンドルが 0x01402c のウィンドウが選択されているかどうかを判定します
wait_active()
ウィンドウが選択される(アクティブになる)まで待機します
wait_active(self, timeout=20)
入力パラメータ
timeout:ウィンドウが選択されるまで待機する際のタイムアウト時間です。デフォルトの待機時間は20秒で、この時間を過ぎても対象ウィンドウが選択されていない場合はUIAError例外をスローします
戻り値
なし
例1
from xbot import win32
def main(args):
wnd = win32.get_by_handle(0x01402c)
wnd.wait_active(20)
この例の実行内容: ハンドルが 0x01402c のウィンドウがアクティブになるまで待機します
wait_close()
ウィンドウが閉じるまで待機します
wait_close(self, timeout=20)
入力パラメータ
timeout:ウィンドウが閉じるまで待機する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒で、この時間を過ぎてもウィンドウが閉じていない場合はUIAError例外をスローします
戻り値
bool:ウィンドウが閉じた場合はTrue、それ以外の場合はFalseを返します
例1
from xbot import win32
def main(args):
wnd = win32.get('新建文本')
wnd.wait_close(20)
この例の実行内容: ウィンドウタイトルが 新建文本 のウィンドウが閉じるまで待機します
find_all
ウィンドウ内でセレクターに一致するすべての要素を取得し、要素リストを返します
find_all(self, selector, timeout=20)
入力パラメータ
selector:検索するセレクターです。str型(要素ライブラリ内の要素を検索)とSelector型(フロー内で取得済みのウィンドウオブジェクト)の2つの形式に対応しています
timeout:ウィンドウの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です
戻り値
- List[Win32Element]:ウィンドウ内で対象要素に類似する要素のリストを返します
例1
from xbot import win32
def main(args):
elements = win32.get('新建文本').find_all('文件(F)')
この例の実行内容: ウィンドウタイトルが 新建文本 のウィンドウ内で、要素名 文件(F) に一致するすべての要素のリストを取得します
find()
ウィンドウ内で要素セレクターに一致する要素を取得します
find(self, selector, timeout=20)
入力パラメータ
selector:検索するセレクターです。str型(要素ライブラリ内の要素を検索)とSelector型(フロー内で取得済みのウィンドウオブジェクト)の2つの形式に対応しています
timeout:ウィンドウの類似要素リストを取得する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です
戻り値
Win32Element:ウィンドウ内で要素名に一致する要素を返します
例1
現在のウィンドウ内でセレクター 文件(F) に一致する要素を取得して返します
from xbot import win32
def main(args):
wnd = win32.get('新建文本')
element = wnd.find('文件(F)')
この例の実行内容: ウィンドウタイトルが 新建文本 のウィンドウ内で、要素名が 文件(F) の要素を取得します
wait_appear()
要素が表示されるまで待機します
*wait_appear(self, selector_or_element, timeout=20)
入力パラメータ
selector_or_element:検索するセレクターです。str型(要素ライブラリ内の要素を検索)、Selector型(フロー内で取得済みのウィンドウオブジェクト)、Win32Element型(Win32要素オブジェクト)の3つの形式に対応しています
timeout:ウィンドウ内で対象要素が表示されるまで待機する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です
戻り値
bool:対象要素がウィンドウ内に表示された場合は True、それ以外の場合は False を返します
例1
from xbot import win32
def main(args):
wnd = win32.get('新建文本')
wnd.wait_appear('文件(F)', 20)
この例の実行内容: ウィンドウタイトルが 新建文本 のウィンドウ内で、名称が 文件(F) の要素が表示されるまで待機します。タイムアウト時間は20秒です
wait_disappear()
現在のウィンドウ内で、対象要素または要素セレクターに一致する要素が消失するまで待機します
wait_disappear(self, selector_or_element, timeout=20)
入力パラメータ
selector_or_element:検索するセレクターです。str型(要素ライブラリ内の要素を検索)、Selector型(フロー内で取得済みのウィンドウオブジェクト)、Win32Element型(Win32要素オブジェクト)の3つの形式に対応しています
timeout:ウィンドウ内で対象要素が消失するまで待機する際のタイムアウト時間です。デフォルトのタイムアウト時間は20秒です
戻り値
bool:対象要素がウィンドウ内から消失した場合は True、それ以外の場合は False を返します
例1
from xbot import win32
def main(args):
wnd = win32.get('新建文本')
wnd.wait_disappear('文件(F)', 20)
この例の実行内容: ウィンドウタイトルが 新建文本 のウィンドウ内で、名称が 文件(F) の要素が消失するまで待機します。タイムアウト時間は20秒です
contains_element()
現在のウィンドウ内に要素セレクターに一致する要素が含まれているかどうかを確認します
contains_element(self, selector)
入力パラメータ
selector:検索するセレクターです。str型(要素ライブラリ内の要素を検索)とSelector型(フロー内で取得済みのウィンドウオブジェクト)の2つの形式に対応しています
戻り値
bool:ウィンドウに対象要素が含まれている場合は True、それ以外の場合は False を返します
例1
from xbot import win32
def main(args):
wnd = win32.get_by_handle(0)
contains_element = wnd.contains_element('文件(F)')
print(contains_element)
この例の実行内容: 現在のウィンドウ内に要素セレクター 文件(F) に一致する要素が含まれているかどうかを判定します --> 判定結果を出力します
wait_focus()
ウィンドウがフォーカスを取得するまで待機します
wait_focus(self, timeout=20)
入力パラメータ
timeout:ウィンドウがフォーカスを取得するまで待機する際のタイムアウト時間です。デフォルトは20秒で、タイムアウトしてもウィンドウがフォーカスを取得していない場合は False を返します。timeoutは0(待機しない)と-1(待機し続ける)にも設定できます
戻り値
bool:ウィンドウがフォーカスを取得したかどうかの結果を返します。フォーカスを取得した場合は True、それ以外の場合は False を返します
例1
from xbot import win32
def main(args):
hWnd = win32.get_by_selector('新建文本文档')
is_focus = hWnd.wait_focus()
print(is_focus)
この例の実行内容: 要素 新建文本文档 が存在するウィンドウがフォーカスを取得するまで待機します --> 判定結果を出力します
wait_focusout()
ウィンドウがフォーカスを失うまで待機します
wait_focusout(self, timeout=20)
入力パラメータ
timeout:ウィンドウがフォーカスを失うまで待機する際のタイムアウト時間です。デフォルトは20秒で、タイムアウトしてもウィンドウがフォーカスを取得していない場合は False を返します。timeoutは0(待機しない)と-1(待機し続ける)にも設定できます
戻り値
bool:ウィンドウがフォーカスを失ったかどうかの結果を返します。フォーカスを失った場合は True、それ以外の場合は False を返します
例1
from xbot import win32
def main(args):
hWnd = win32.get_by_selector('新建文本文档')
is_focus = hWnd.wait_focusout()
print(is_focus)
この例の実行内容: 要素 新建文本文档 が存在するウィンドウがフォーカスを失うまで待機します
call_transaction
SAPでトランザクションを開きます
call_transaction(self, tcode)
入力パラメータ
tcode: SAPのトランザクションコードです。例:MM01
戻り値
なし
例1
import xbot
from xbot import print, sleep
from .import package
from .package import variables as glv
def main(args):
sap_wnd = xbot.win32.get('SAP 轻松访问')
sap_wnd.call_transaction("MM01")
wait_load_completed
SAPの読み込みが完了するまで待機します
wait_load_completed(self, timeout=20)
入力パラメータ
timeout: SAPの読み込みが完了するまで待機する際のタイムアウト時間です。デフォルトは20秒で、タイムアウトしてもSAPの読み込みが完了していない場合は False を返します
戻り値
bool:SAPの読み込みが完了したかどうかを返します。完了した場合は True、それ以外の場合は False を返します
例1
import xbot
from xbot import print, sleep
from .import package
from .package import variables as glv
def main(args):
sap_wnd = xbot.win32.get('SAP 轻松访问')
sap_wnd.call_transaction("MM01")
res = sap_wnd.wait_load_completed(timeout=20)
print(res)
read_status_bar
SAPのステータスバーの情報を読み取ります
read_status_bar(self)
入力パラメータ
なし
戻り値
list: 2つの要素を含むリストです。各要素は、ステータスバーの情報の種類と、ステータスバーの情報の内容です。
例1
import xbot
from xbot import print, sleep
from .import package
from .package import variables as glv
def main(args):
sap_wnd = xbot.win32.get_active()
status_type, status_content = sap_wnd.read_status_bar()
print(f'status_type: {status_type}, status_content: {status_content }')
select_menu_item
SAPのメニューバーでメニュー項目を選択します
select_menu_item(self, path)
入力パラメータ
path:SAPのメニュー項目の完全なパスです
戻り値
なし
例1
import xbot
from xbot import print, sleep
from .import package
from .package import variables as glv
def main(args):
sap_wnd = xbot.win32.get('SAP 轻松访问')
sap_wnd.select_menu_item('菜单/业务工作台')