SBKScriptItem オブジェクト

・実行中のスクリプトを制御するためのオブジェクトです。
・スクリプト内で SBKScriptItem オブジェクトは記述を省略することができます。

プロパティ

2列目の項目は、読み込み専用の場合 'R' (Read) 、読み書き可能な場合は 'RW'(Read/Write)です。

Caller R

下の2つの場合に有効なプロパティです。

(1)ホームページの更新チェック機能のチェック前と更新時に実行されたスクリプト
更新チェック項目のUpdateCheckItemオブジェクトを返します。
(参照) [更新チェック項目のプロパティ画面]-[拡張動作]ページの「更新時に実行するスクリプト]欄

(2)自動ログイン項目の[実行前スクリプト]と[実行後スクリプト]
ログイン処理を行ったWebページのAutoLogin オブジェクトを返します。
(参照)ログイン項目のプロパティ画面

(3)[ScriptBrowserKオプション]-[イベント起動]ページのスクリプト
呼び出し元のDocument オブジェクト(HTMLページ内のJava Script等で使用する document オブジェクトと同じもの)を返します。フレーム内のページが呼び出し元の場合は、該当するフレームのDocumentオブジェクトが返されます。

(4)スクリプトパネル上でスクリプトを実行した場合
アクティブなタブのDocumentWindow オブジェクトのDocumentプロパティを返します。

Filename R 実行中のスクリプトのファイル名です。
DebugMode RW TRUEのとき、デバッグモードになります。DebugLog メソッドはデバッグモードのときのみログを出力します。
NavigatingURL R

[ScriptBrowserKオプション]-[イベント起動]ページで[イベント]欄に[開くとき]に指定した項目のスクリプトが実行されるときのみ有効なプロパティです。

表示しようとしているURLを返します。

DocumentWindow オブジェクトのURLプロパティは現在表示しているURLを返します。違いに注意してください。

ParamCount R スクリプトに渡されたパラメータの数を返します。
(参照)スクリプトの概要(一般ユーザ用)の「スクリプトにパラメータを渡す」の解説
ParamStr R 書式:ParamStr(INDEX)

INDEX番目のパラメータ文字列を返します。
ParamStr(0)が先頭のパラメータになります。
(参照)スクリプトの概要(一般ユーザ用)の「スクリプトにパラメータを渡す」の解説

SrcDocWin R

下の2つの場合に有効なプロパティです。

(1)[ScriptBrowserKオプション]-[イベント起動]ページの機能でスクリプトが実行された場合
表示されたブラウザウィンドウDocumentWindow オブジェクトを返します。

(2)自動ログイン項目の[実行後スクリプト]
ログイン処理を行ったWebページのDocumentWindow オブジェクトを返します。
(参照)ログイン項目のプロパティ画面

(4)スクリプトパネル上でスクリプトを実行した場合
アクティブなタブのDocumentWindow オブジェクトを返します。

メソッド

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)

別のスクリプトを実行します。

Filename 引数には実行するスクリプトのファイル名を指定します。 相対パスを指定した場合は、下の3つのフォルダのパスからスクリプトファイルを順次検索します
・呼び出し元のスクリプトファイルが存在するフォルダ
[ScriptBrowserKオプション]-[フォルダ]ページの[スクリプトフォルダ ]で指定したフォルダ
ScriptBrowserK をインストールしたフォルダ下の Script フォルダ

Wait  スクリプトの終了を待つ場合はTRUEを返します。

GetVariableValue 書式:GetVariableValue(Name)
指定した名前の ScriptBrowserK のスクリプトのオートフィルの記録項目の値を返します。実行中のスクリプトから別のスクリプトの記録項目を読み取ることはできません。
Name  記録項目の名前を指定します。
GM_getValue

書式:GM_getValue(key, defaultValue)

下の GM_setValue メソッドで保存した値を読み出します。 key の値が存在しない場合は、戻り値が defaultValue になります。

GM_registerMenuCommand

書式:GM_registerMenuCommand(menuText, callbackFunction)

GreaseMonkey 互換機能の関数です。

[スクリプト]メニューの[ユーザスクリプトのコマンド]下にメニュー項目を追加します。

menuText :メニューのキャプション名を指定します。
callbackFunction:メニューが実行されたときに呼び出す関数を指定します。

GM_setValue

書式:GM_setValue(key, value)

key と value の値を保存します。 保存した値は、上の GM_getValue メソッドで読み込むことができます。

保存された値は、[ScriptBrowserKオプション]-[フォルダ]ページで[スクリプトのパラメータを保存するフォルダ]が指定されている場合はそのフォルダに、そうでない場合は、設定ファイル保存フォルダ下の ScriptParam フォルダ下にスクリプトファイル毎に別々のファイルに保存されます。

InputParams 書式:InputParams(Title, Params, Values)
パラメータを入力する画面を表示します。スクリプトのオートフィル機能が有効になっていれば、前回入力した内容が自動的に入力した状態で画面が開きます。また、Shift キーを押しながら実行されると、前回入力した内容を入力されたものとして、入力画面を表示することなく Values に値をセットしてメソッドを終了します。OKがクリックされたときは、TRUE を、キャンセルされたときは FALSE を返します。

Title  入力画面のウィンドウのタイトルを指定します。
Params  フォーマットに従った内容を配列に入れて渡します。
Values  入力された内容が返されます。Params と同じ要素数の配列を渡します。
InputParamsWithParamSet 書式:InputParamsWithParamSet(Title, Params, Values)

コマンドラインのプログラムなどを呼び出すための機能です。

上の InputParams の機能に加え、設定内容に名前を付けて保存することが出来ます。設定内容は、[ScriptBrowserKオプション]-[フォルダ]ページ-[スクリプトのパラメータを保存するフォルダ]下に保存されます。

ただし、ここで入力した内容はパスワードで保護されません。入力した内容は普通のテキストファイルに保存されます。

ValuesにはWindowsスクリプトのDictionaryオブジェクトを渡すこともできます。Dictionaryオブジェクトを渡した場合は、Dictionary.Keyに、nameで指定した名前が、Item に値が返ります。

例)下の行の項目がチェックされた場合、
checkbox: Title=項目1, name=Name1, value=SelValue
Keyには Name1 が、Item には SelValue が代入されます。

SetVariableValue 書式:SetVariableValue(Name, Value)
指定した名前のスクリプトのオートフィルの記録項目の値をセットします。実行中のスクリプトから別のスクリプトに記録項目をセットすることはできません。
Name セットする 記録項目の名前を指定します。
Value  記録項目にセットする値を指定します。

 


Copyright (c) 1998-2008 Akiyoshi Kozuka (http://www.scriptbrowserk.com/)