Click

3.2.3 Click

説明

ClickはWaitfor matchとMouseコマンドの組み合わせです。コンポーネント画像、ソリッドカラーオブジェクト、またはテキストをデスクトップから探してクリックします。オブジェクトが見つからない場合はスクリプトを終了します。

SYNOPSIS

Click <comparison_method> [timeout=<time>] [cmparea=<[x:<x>][,y:<y>][,w:<width>][,h：<height>]>] [number=<component_number>] [btn=<button>][modifiers=<modifiers>] [count=<number>] [wait=<time>][<method specific options>]

赤色は必須パラメーターを示します

comparison_method

-サポートされているメソッドは以下の通り：

'image'(画像) - コンポーネントを画像もしくはImage Collectionsメソッドを使ってImage Search V2 メソッドを使用します、
'object' - メソッドを使って色でコンポーネントを検索します。Object Search ("object")メソッドを使用します、
'ocr' - OCR (tocr メソッド) を使用して画面上のテキストを認識し、指定された文字列またはパターンを見つけます。

共通オプション

timeout=<time>

-コンポーネントが画面に表示されるまでの最大待機時間を指定するタイムアウト。値はミリ秒単位の数値または有効なTime Valuesでなければなりません。デフォルト値は30秒です。

cmparea=[x:<x>],[y:<y>],[w:<width>],[h:<height>]

-比較を制限するデスクトップの矩形領域。このパラメータを省略すると、リモートデスクトップ全体が処理されます。領域の座標は「x:<x>,y:<y>,w:<width>,h:<height>」のフォーマットで、各座標はピクセル単位（例えば「x:225」）またはパーセント単位（「x:23%」）で指定できます。x,y,width,heightのいずれかが省略された場合、T-Plan Robotはフルスクリーンの値を用いて不足するパラメータを決定します(x:0, y:0, w:<screen_width>, h:<screen_height>)。

number=<component_number>

クリックを適用する画面上のコンポーネントの番号。画面上のコンポーネント(オブジェクト)は、上から下、左から右の順にソートされます。デフォルト値は1（最初にあるコンポーネントをクリック）です。画面上で見つかったコンポーネントの数が指定した数より少ない場合、コマンドはスクリプトを終了します。

move=[x:<x>],[y:<y>]

-ターゲットオブジェクトの中心からの相対的なクリック位置を指定します(4.2以降)。これにより、オブジェクトそのものではなく、近くの場所をクリックすることができます。比較対象が画像の場合、このパラメータは画像を上書きします。Image Meta Dataを上書きし、画像の中心を基準点として使用します。例えば、"Click image template=button.png move=x:-40 "のコマンドは、ボタンの中心から40ピクセル左をクリックします。

btn=<ボタン>

-クリックするマウスボタン。指定可能な値は "left"、"middle" および "right" です。

modifiers=<修飾子>

-マウスイベント修飾子(オプション)。値はShift、Alt、Ctrlの任意の組み合わせで、「Ctrl+Alt+Shift」のようにプラス「+」記号で区切ります。

count=<数値>

-クリックする回数。デフォルト値は1。

continue=<数字>

-trueを指定すると、オブジェクトが見つからなかった場合にスクリプトを終了しない(4.2以降)。デフォルト値はfalse（失敗時に終了）。リリース4.4.2以降、コマンドは_CLICK_CONNECT変数の値も監視し、デフォルト値として使用します。例えば、スクリプト内のすべてのClickコマンドをデフォルトで終了させないようにするには、最初にこの変数をtrueに設定します("Var _CLICK_CONTINUE=true")。

step=<ステップ名>

-コマンドとのシンプルな統合。Stepコマンドとのシンプルな統合(4.2以降)。指定された場合、指定された名前のテストステップを作成し、結果は合格（オブジェクトが見つかりクリックされた）または不合格（オブジェクトが見つからなかった）です。

wait=<時間>

-クリック後の待ち時間。次のコマンドが「Wait <time_in_ms>」であった場合と同じ効果を持つ。値はミリ秒数か有効な値でなければならない。Time Values.デフォルト値は0（待機しない）である。スクリプトは、"Var _CLICK_WAIT=1s "のように、_CLICK_WAIT変数に希望の遅延を代入することでデフォルト値を設定することができます。

Click image template=<image_collection> [passrate=<pass_rate_in_%>] [<searchv2_specific_params>] [<click_common_params>]

赤色は必須パラメーターを示します。

特定のオプション - image

template=<image_collection>

-画像コレクション(Image Collections)- リモートデスクトップ画像と比較する、セミコロン（;）で区切られた1つ以上の画像ファイル名または画像を含むフォルダ。Linux/Unixでは、リストが誤って解析されるため、ファイル名にセミコロンを含めないでください。ファイル名は相対パス（例: img.png）または絶対パス（例: /root/report/img.png）のいずれでも指定可能です。相対パスを使用する場合、画像は_template_dirで定義されたディレクトリ内で検索されます。サポートされる画像形式はJavaのバージョンに依存します。Java 1.6では少なくともPNG、JPG、GIF、BMPがサポートされています。

テンプレート画像は、指定されたリスト順序でリモートデスクトップ画像と比較されます。テンプレートの比較で肯定的な結果（指定されたイベントに応じて、一致または不一致のいずれか）が得られた場合、条件は満たされたとみなされ、コマンドは終了コード0で終了し、リスト内の残りのテンプレートをスキップします。定義済み変数 _COMPARETO_TEMPLATE_INDEX は、マッチするテンプレート画像のインデックスを決定するために使われます。対応する変数の一覧は画像比較固有の変数を参照してください。

passrate=<pass_rate_in%>

-画像比較の通過率。0から100の間の数値を指定し、その後にパーセンテージを指定することもできます(例: "passrate=95 "または "passrate=95%")。このパラメータが省略された場合、デフォルトのsearch2通過率50%が使用されます。

search2_specific_params

-比較メソッドでサポートされるsearch2比較メソッドでサポートされる任意のパラメータ（オプション）。

Click object [<object_specific_options>] [<common_options>]。

特定のオプション - オブジェクト

オブジェクト固有パラメータ

-オブジェクト比較メソッドでサポートされる任意のパラメータ（オプション）。通常、少なくともオブジェクトの色を指定する必要があります。

Click ocr [<ocr_specific_options>] [<common options>]。

特定のオプション - ocr

tocr_specific_options

-比較メソッドでサポートされる Text OCR ("tocr")比較メソッドでサポートされる任意のパラメータ。textまたはpatternオプションを通して、クリックを適用するターゲットテキストを指定する必要がある。

戻り値

このコマンドは成功すると常に0を返し、失敗すると指定された比較メソッドのエラーコードを返してスクリプトを終了します。

例

JS

Click image template="google_button.png"number="2"

画面上のgoogle_button.png画像で指定された2番目のボタンをクリックします。ボタンが見つからない場合、または画面上のボタンの数が2つ以下の場合、コマンドはスクリプトに失敗します。

JS

Click object tolerance="10" color="255;0;0" max="w:20"

赤色で幅が20ピクセル以下のオブジェクトをクリックします。トレランスは、メソッドがより多くの赤の色合いを見つけることを保証します。

JS

Click ocr text="Cancel" distance="1"

OCRを使って画面上のテキストを読み取り、"Cancel "という単語をクリックします。この距離により、OCR エンジンが、たとえば「Cancel」などの 1 文字を省略したり、認識できなかったりしても、単語が確実に検出されます。