SBKScriptItem オブジェクト
・実行中のスクリプトを制御するためのオブジェクトです。
・スクリプト内で SBKScriptItem オブジェクトは記述を省略することができます。
プロパティ
2列目の項目は、読み込み専用の場合 'R' (Read) 、読み書き可能な場合は 'RW'(Read/Write)です。
CallBy | R | スクリプトが起動したタイミング(スクリプトの設定場所)を取得します。 下記の数値が返ります。
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Caller | R | 下の2つの場合に有効なプロパティです。 (1)ホームページの更新チェック機能のチェック前と更新時に実行されたスクリプト (2)自動ログイン項目の[実行前スクリプト]と[実行後スクリプト] (3)[ScriptBrowserKオプション]-[イベント起動]ページのスクリプト (4)スクリプトパネル上でスクリプトを実行した場合 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Filename | R | 実行中のスクリプトのファイル名です。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DebugMode | RW | TRUEのとき、デバッグモードになります。DebugLog メソッドはデバッグモードのときのみログを出力します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NavigatingURL | R | [ScriptBrowserKオプション]-[イベント起動]ページで[イベント]欄に[開くとき]に指定した項目のスクリプトが実行されるときのみ有効なプロパティです。 表示しようとしているURLを返します。 DocumentWindow オブジェクトのURLプロパティは現在表示しているURLを返します。違いに注意してください。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ParamCount | R | スクリプトに渡されたパラメータの数を返します。 (参照)スクリプトの概要(一般ユーザ用)の「スクリプトにパラメータを渡す」の解説 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ParamStr | R | 書式:ParamStr(INDEX) INDEX番目のパラメータ文字列を返します。 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SrcDocWin | R |
下の2つの場合に有効なプロパティです。 (1)[ScriptBrowserKオプション]-[イベント起動]ページの機能でスクリプトが実行された場合 (2)自動ログイン項目の[実行後スクリプト] (4)スクリプトパネル上でスクリプトを実行した場合 |
メソッド
ClickDialogItem | 書式:ClickDialogItem(WindowTitle, Item, Wait, SameProcess, TimeoutSecond, ForScript) セキュリティの確認画面などのボタンをクリックします。 ウィンドウのキャプションがWindowTitleの文字列を含むダイアログボックスのItemの文字列を含むボタンをクリックします。 Wait引数には待機方法を指定します。各値の意味は下記の通りです。
SameProcess引数がTRUEの場合、ScriptBrowserK と同じプロセスのウィンドウのみ検索します。SameProcessがFALSEの場合、全プロセスのウィンドウを検索します。SameProcess引数は省略可能で省略時は TRUE と見なされます。 TimeoutSecond は、タイムアウトエラーが発生するまでの時間を秒で指定します。省略可能で、省略した場合は 5秒に設定されます。 ForScript は、Webページ内のスクリプトでイベント(OnClick等)内で確認画面が表示される場合のためのオプションです。TRUEを指定するとタイムアウトするまで別スレッドでダイアログボックスが開かれるまで待つようになります。 例) |
|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CreateHTMLDocumentByString | 書式:CreateHTMLDocumentByString(str, document) str 引数の内容を、HTMLソースとして docment オブジェクトを作成します。 document は省略可能な引数で、作成したdocment オブジェクトに document の URL を base タグとして追加します。 document 引数を省略した場合、Caller プロパティがdocument オブジェクトであればそのURLを、そうでない場合は SrcDocWinプロパティの URL プロパティの値を base タグとして追加します。 |
|||||||||||||||
DebugLog |
書式:DebugLog(Msg) Msg 引数の内容を、スクリプトパネルの[記録されたスクリプト]欄に出力します。 (注意)DebugModeプロパティが TRUE の時のみ動作します。FALSE のときは何もしません。 |
|||||||||||||||
ExecScript |
書式:ExecScript(Filename, Wait, SrcDocWin, Caller)
別のスクリプトを実行します。 Filename 引数には実行するスクリプトのファイル名を指定します。パスを付けずにファイル名のみを指定すると、下のページの解説されているフォルダが自動的に検索されます。 [SBKスクリプト]-[5.パス省略時に自動的に検索されるフォルダ] Wait 引数は、スクリプトの終了を待つ場合に true を指定します。待たない場合は false を指定します。 SrcDocWin 引数には DocumentWindow オブジェクトを指定します。実行するスクリプトの SrcDocWin プロパティにセットされます。この引数は省略可能です。 Caller 引数には、実行するスクリプトの Caller プロパティにセットする値を指定します。通常は caller プロパティをそのまま渡します。この引数は省略可能です。 |
|||||||||||||||
GetVariableValue |
書式:GetVariableValue(Name) 指定した名前の ScriptBrowserK のスクリプトのオートフィルの記録項目の値を返します。実行中のスクリプトから別のスクリプトの記録項目を読み取ることはできません。 Name 記録項目の名前を指定します。 |
|||||||||||||||
GM_getValue | 書式:GM_getValue(key, defaultValue) 下の GM_setValue メソッドで保存した値を読み出します。 key の値が存在しない場合は、戻り値が defaultValue になります。 |
|||||||||||||||
GM_registerMenuCommand | 書式:GM_registerMenuCommand(menuText, callbackFunction) GreaseMonkey 互換機能の関数です。 [スクリプト]メニューの[ユーザスクリプトのコマンド]下にメニュー項目を追加します。 menuText :メニューのキャプション名を指定します。 |
|||||||||||||||
GM_setValue | 書式:GM_setValue(key, value) key と value の値を保存します。 保存した値は、上の GM_getValue メソッドで読み込むことができます。 保存された値は、[ScriptBrowserKオプション]-[フォルダ]ページで[スクリプトのパラメータを保存するフォルダ]が指定されている場合はそのフォルダに、そうでない場合は、設定ファイル保存フォルダ下の ScriptParam フォルダ下にスクリプトファイル毎に別々のファイルに保存されます。 |
|||||||||||||||
InputParams |
書式:InputParams(Title, Params, Values) スクリプトのオートフィル機能が有効になっていれば、前回入力した内容が自動的に入力した状態で画面が開きます。また、Shift キーを押しながら実行されると、前回入力した内容を入力されたものとして、入力画面を表示することなく Values に値をセットしてメソッドを終了します。 OKがクリックされたときは、TRUE を、キャンセルされたときは FALSE を返します。 Values には Windows スクリプトの Dictionary オブジェクトを渡すこともできます。 例)下の行の項目がチェックされた場合、 |
|||||||||||||||
InputParamsWithParamSet |
書式:InputParamsWithParamSet(Title, Params, Values) コマンドラインのプログラムなどを呼び出すための機能です。 上の InputParams の機能に加え、設定内容に名前を付けて保存することが出来ます。設定内容は、[ScriptBrowserKオプション]-[フォルダ]ページ-[スクリプトのパラメータを保存するフォルダ]下に保存されます。 ただし、ここで入力した内容はパスワードで保護されません。入力した内容は普通のテキストファイルに保存されます。 |
|||||||||||||||
LoadScriptLibrary | 書式:LoadScriptLibrary(Filename) スクリプトファイルをライブラリとして読み込み、実行します。ExecScript メソッドと異なり、同じ名前空間で実行されます。 Filename 引数には実行するスクリプトのファイル名を指定します。パスを付けずにファイル名のみを指定すると、下のページの解説されているフォルダが自動的に検索されます。 [SBKスクリプト]-[5.パス省略時に自動的に検索されるフォルダ] 例)SbkConst.sbj (.sbv) 内で定義されている sbkPnlPageSearch を利用する例 ●JavaScript の場合 ●VBScript の場合 |
|||||||||||||||
Quit | 書式:Quit() 現在実行中のスクリプトを終了します。 |
|||||||||||||||
QuitAll | 書式:QuitAll() 現在実行中のスクリプトを終了し、実行待ちスクリプトを全てキャンセルします。 |
|||||||||||||||
SendKeys2 | 書式:SendKeys2(Keys, WaitMode, WindowTitle, WaitMSec, TimeoutSecond) アクティブなウィンドウに Keys 引数の文字列やキー操作をエミュレートして送ります。 Keys引数には全角文字も送信できます。 詳細は、SendKeys2 の Keysプロパティの書式の解説を参照して下さい。 WaitMode にはキーを送信するまでの待機方法を指定します。各値の意味は下記の通りです。
WindowTitle には、ウィンドウキャプション、ウィンドウクラスの「一部分」、または、「全て」を指定できます。 WaitMSec は、WindowTitle で指定したウィンドウが生成されてから、キーを送信するまでの待機時間をミリ秒で指定します。省略可能で、省略した場合は 100ミリ秒に設定されます。 TimeoutSecond は、タイムアウトエラーが発生するまでの時間を秒で指定します。省略可能で、省略した場合は 5秒に設定されます。 例) (1)JavaScript の Prompt メソッドで値を入力する場合 SendKeys2("Test 入力データ{Enter}", 2, "ユーザー プロンプト", 100, 5); (2)ページを保存時に、ファイル名を自動入力する SendKeys2("保存するファイル名~", 2, "ページの保存", 100, 5) |
|||||||||||||||
SetVariableValue |
書式:SetVariableValue(Name, Value) 指定した名前のスクリプトのオートフィルの記録項目の値をセットします。実行中のスクリプトから別のスクリプトに記録項目をセットすることはできません。 Name セットする 記録項目の名前を指定します。 Value 記録項目にセットする値を指定します。 |