NilBrowserスクリプトリファレンス

NilBrowserのスクリプトはIEの拡張呼び出し(window.external)を利用して動作します。
　NilBrowserは起動時に.\scripts\以下のスクリプトを読み込みます。
　対象となるファイルの拡張子は、htm/js/vbsになります。

　APIを利用できるのは、ローカル・ネットワーク上にあるファイルのみです。
　インターネット上にあるスクリプトファイルは、動作しないように制限してあります。

htmファイルとして作成する場合

ヘッダーに以下の形式を指定するとスクリプト設定画面に詳細情報を表示できます。
-------------------------------------------------------------
<!--NilBrowserScriptFile1.00
@SCRIPT_NAME:スクリプトメニューに表示される名称
@VERSION:ファイルバージョン
@COPYRIGHT:著作権
@COMMENT:スクリプトの説明
-->
<SCRIPT>
ここにスクリプトを記述する。
</SCRIPT>
-------------------------------------------------------------
ファイルの拡張を.htmにし保存します。

jsファイルとして作成する場合

ヘッダーに以下の形式を指定するとスクリプト設定画面に詳細情報を表示できます。
-------------------------------------------------------------
//NilBrowserScriptFile1.00
//@SCRIPT_NAME:スクリプトメニューに表示される名称
//@VERSION:ファイルバージョン
//@COPYRIGHT:著作権
//@COMMENT:スクリプトの説明
//NilBrowserScriptEnd
ここにスクリプトを記述する。
-------------------------------------------------------------
ファイルの拡張を.jsにし保存します。

vbsファイルとして作成する場合

ヘッダーに以下の形式を指定するとスクリプト設定画面に詳細情報を表示できます。
-------------------------------------------------------------
'NilBrowserScriptFile1.00
'@SCRIPT_NAME:スクリプトメニューに表示される名称
'@VERSION:ファイルバージョン
'@COPYRIGHT:著作権
'@COMMENT:スクリプトの説明
'NilBrowserScriptEnd
ここにスクリプトを記述する。
-------------------------------------------------------------
ファイルの拡張を.vbsにし保存します。

スクリプトにアイコンを表示する方法

ファイル名と同じ名称のicoファイルを設置します。
sample.htmの場合
sample.htm.icoをscriptフォルダに配置します。

NilBrowser API　1.00　リファレンス

キーボード
NilBrowser
BrowserObject
セキュリティ
タブロック
ウインドウ操作
その他

・キーボード

NilBrowser_ShiftDown

 [bool] NilBrowser_ShiftDown(HTMLDocument doc)
 [説明]
 　Shift キーの状態を返す。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　押されている場合は、true

NilBrowser_CtrlDown

 [bool] NilBrowser_CtrlDown(HTMLDocument doc)
 [説明]
 　Ctrl キーの状態を返す。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　押されている場合は、true

NilBrowser_AltDown

 [bool] NilBrowser_AltDown(HTMLDocument doc)
 [説明]
 　Alt キーの状態を返す。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　押されている場合は、true

・NilBrowser

NilBrowser_AppPath

 [string] NilBrowser_AppPath(HTMLDocument doc)
 [説明]
 　起動しているNilBrowser.exeのディレクトリを返す。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　ディレクトリへのパス

NilBrowser_ScriptPath

 [string] NilBrowser_ScriptPath(HTMLDocument doc)
 [説明]
 　スクリプトの読込まれるディレクトリを返す。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　ディレクトリへのパス

NilBrowser_ResourcePath

 [string] NilBrowser_ResourcePath(HTMLDocument doc)
 [説明]
 　リソースの読込まれるディレクトリを返す。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　ディレクトリへのパス

NilBrowser_Handle

 [long] NilBrowser_Handle(HTMLDocument doc)
 [説明]
 　NilBrowserのメインウインドハンドルを返す。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　ウインドウハンドル

NilBrowser_Version

 [string] NilBrowser_Version(HTMLDocument doc)
 [説明]
 　NilBrowserのバージョンを返す。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　バージョン情報

・BrowserObject

NilBrowser_GetActiveTabDoc2Ptr

 [IDispatch] NilBrowser_GetActiveTabDoc2Ptr(HTMLDocument doc)
 [説明]
 　アクティブなタブのHTMLDocumentを取得する。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　HTMLDocument
 　(アクティブタブがない場合や、取得に失敗した場合は、nullが戻ります。)

NilBrowser_GetCount

 [long] NilBrowser_GetCount(HTMLDocument doc)
 [説明]
 　タブの数を取得する。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　タブの数

NilBrowser_GetIndex

 [long] NilBrowser_GetIndex(HTMLDocument doc,long id)
 [説明]
 　ドキュメント固有の ID からタブ位置を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　タブ位置

NilBrowser_GetActiveIndex

 [long] NilBrowser_GetActiveIndex(HTMLDocument doc)
 [説明]
 　アクティブなドキュメントのタブ位置を取得する。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　タブ位置

NilBrowser_GetActiveID

 [long] NilBrowser_GetActiveID(HTMLDocument doc)
 [説明]
 　アクティブなドキュメントの固有のIDを取得する。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　ドキュメント固有のID

NilBrowser_GetDocumentID

 [long] NilBrowser_GetDocumentID(HTMLDocument doc,long index)
 [説明]
 　ドキュメント固有のIDを取得する。
 [引数]
 　doc:HTMLDocument
 　index:タブ位置(0 ～ GetCount-1)
 [戻り値]
 　ドキュメント固有のID

NilBrowser_GetWindowObject

 [IDispatch] NilBrowser_GetWindowObject(HTMLDocument doc,long id)
 [説明]
 　Window Object を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　Windows ObjectのIDispatch

NilBrowser_GetDocumentObject

 [IDispatch] NilBrowser_GetDocumentObject(HTMLDocument doc,long id)
 [説明]
 　HTMLDocument Objectを取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　HTMLDocument ObjectのIDispatch

NilBrowser_GetWebBrowserObject

 [IDispatch] NilBrowser_GetWebBrowserObject(HTMLDocument doc,long id)
 [説明]
 　WebBrowser Object を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　WebBrowser ObjectのIDispatch

NilBrowser_IsBusy

 [bool] NilBrowser_IsBusy(HTMLDocument doc,long id)
 [説明]
 　ドキュメントが読み込み中か判断する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　読み込み中の場合は true

NilBrowser_GetActiveURL

 [string] NilBrowser_GetActiveURL(HTMLDocument doc)
 [説明]
 　アクティブなドキュメントのURLを取得する。
 　ActiveDocument.Locationを呼び出してもIEのセキュリティの制限で警告が表示されるので
 　URLを取得するために追加
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　URL

NilBrowser_GetActiveTitle

 [string] NilBrowser_GetActiveTitle(HTMLDocument doc)
 [説明]
 　アクティブなドキュメントのTitleを取得する。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　TitleL

NilBrowser_GetURL

 [string] NilBrowser_GetURL(HTMLDocument doc,HTMLDocument docTarget)
 [説明]
 　指定したドキュメントのURLを取得する。
 　ActiveDocument.Locationを呼び出してもIEのセキュリティの制限で警告が表示されるので
 　URLを取得するために追加
 [引数]
 　doc:HTMLDocument
 　docTarget:URLを取得したいHTMLDocument
 [戻り値]
 　URL

NilBrowser_GetTitle

 [string] NilBrowser_GetTitle(HTMLDocument doc,HTMLDocument docTarget)
 [説明]
 　指定したドキュメントのTitleを取得する。
 [引数]
 　doc:HTMLDocument
 　docTarget:Titleを取得したいHTMLDocument
 [戻り値]
 　URL

・セキュリティ

NilBrowser_SetSecurity

 [void] NilBrowser_SetSecurity(HTMLDocument doc,
                               long id,
                               bool bJavaScript,
                               bool bJava,
                               bool bRunActiveX,
                               bool bDownloadActiveX,
                               bool bPicture,
                               bool bSound,
                               bool bVideo)

 [説明]
 　ドキュメントのセキュリティを設定する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 　bJavaScript:Scriptの有効・無効
 　bJava:Javaの有効・無効
 　bRunActiveX:ActiveXの実行の有効・無効
 　bDownloadActiveX:ActiveXのダウンロードの有効・無効
 　bPicture:画像の表示・非表示
 　bSound:音声再生の有効・無効
 　bVideo:動画再生の有効・無効

 [戻り値]
 　なし

NilBrowser_IsJavaScriptEnabled

 [bool] NilBrowser_IsJavaScriptEnabled(HTMLDocument doc,long id)
 [説明]
 　Scriptの有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsJavaEnabled

 [bool] NilBrowser_IsJavaEnabled(HTMLDocument doc,long id)
 [説明]
 　Javaの有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsRunActiveXEnabled

 [bool] NilBrowser_IsRunActiveXEnabled(HTMLDocument doc,long id)
 [説明]
 　ActiveXの実行の有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsDownloadActiveXEnabled

 [bool] NilBrowser_IsDownloadActiveXEnabled(HTMLDocument doc,long id)
 [説明]
 　ActiveXのダウンロードの有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsPictureEnabled

 [bool] NilBrowser_IsPictureEnabled(HTMLDocument doc,long id)
 [説明]
 　画像表示の有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsSoundEnabled

 [bool] NilBrowser_IsSoundEnabled(HTMLDocument doc,long id)
 [説明]
 　音声再生の有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsVideoEnabled

 [bool] NilBrowser_IsVideoEnabled(HTMLDocument doc,long id)
 [説明]
 　動画再生の有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

・タブロック

NilBrowser_IsNavigateLock

 [bool] NilBrowser_IsNavigateLock(HTMLDocument doc,long id)
 [説明]
 　ナビゲートロックの有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsDomainLock

 [bool] NilBrowser_IsDomainLock(HTMLDocument doc,long id)
 [説明]
 　ドメインロックの有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsLinkLock

 [bool] NilBrowser_IsLinkLock(HTMLDocument doc,long id)
 [説明]
 　リンクロックの有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_IsWheelLock

 [bool] NilBrowser_IsWheelLock(HTMLDocument doc,long id)
 [説明]
 　Wheelロックの有効・無効を取得する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　有効の場合true

NilBrowser_SetNavigateLock

 [void] NilBrowser_SetNavigateLock(HTMLDocument doc,long id,bool bEnable)
 [説明]
 　ナビゲートロックの有効・無効を設定する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 　bEnable: 有効にするなら true
 [戻り値]
 　なし

NilBrowser_SetDomainLock

 [void] NilBrowser_SetDomainLock(HTMLDocument doc,long id,bool bEnable)
 [説明]
 　ドメインロックの有効・無効を設定する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 　bEnable: 有効にするなら true
 [戻り値]
 　なし

NilBrowser_SetLinkLock

 [void] NilBrowser_SetLinkLock(HTMLDocument doc,long id,bool bEnable)
 [説明]
 　リンクロックの有効・無効を設定する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 　bEnable: 有効にするなら true
 [戻り値]
 　なし

NilBrowser_SetWheelLock

 [void] NilBrowser_SetWheelLock(HTMLDocument doc,long id,bool bEnable)
 [説明]
 　Wheelロックの有効・無効を設定する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 　bEnable: 有効にするなら true
 [戻り値]
 　なし

・ウインドウ操作

NilBrowser_NewWindow

 [long] NilBrowser_NewWindow(HTMLDocument doc,string strUrl, bool bActive)
 [説明]
 　新しくドキュメントを開く。
 [引数]
 　doc:HTMLDocument
 　strUrl:新しく開くドキュメントの Url
 　bActive:新しく開くウィンドウをアクティブにするか
 [戻り値]
 　開かれたドキュメント固有の ID

NilBrowser_Close

 [void] NilBrowser_Close(HTMLDocument doc,long id)
 [説明]
 　指定のドキュメントを閉じる。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 [戻り値]
 　なし

NilBrowser_Navigate

 [void] NilBrowser_Navigate(HTMLDocument doc,long id,string strUrl)
 [説明]
 　指定のドキュメントを任意のURLに移動する。
 [引数]
 　doc:HTMLDocument
 　id:ドキュメント固有のID
 　strUrl:ナビゲートするURL
 [戻り値]
 　なし

・その他

NilBrowser_ExecCommand

 [void] NilBrowser_ExecCommand(HTMLDocument doc,long cmdID)
 [説明]
 　NilBrowserの任意のメニューをcmdIDで指定して実行します。
 　cmdID はマウスジェスチャー(nilbrowsercom.def)等から参照してください。
 [引数]
 　doc:HTMLDocument
 　cmdID:コマンドID
 [戻り値]
 　なし

NilBrowser_ShowMenu

 [long] NilBrowser_ShowMenu(HTMLDocument doc,string strMenuItem)
 [説明]
 　メニューを表示します。
 　strMenuItemにカンマ(,)で区切った文字列を指定するとメニューが表示されます。
 　ユーザーがメニューを選択するとIndex番号を返します。
 　ユーザーがメニューを選択しない場合は、-1を返します。
 　,,と指定した場合は、セパレータが表示されます。
 [引数]
 　doc:HTMLDocument
 　strMenuItem:メニューに表示する文字列
 [戻り値]
 　選択したメニューのIndex、選択しない場合は、-1
 [例]
 　var iSelIndex = window.external.NilBrowser_ShowMenu(document,"メニュー1,メニュー2,メニュー3");
 　if(iSelIndex==-1)
 　  alert("選択されませんでした。");
 　else
 　  alert("選択されたのは、"+iSelIndex+"番目です。");

NilBrowser_MessageBox

 [long] NilBrowser_MessageBox(HTMLDocument doc,string strMsg)
 [説明]
 　WinAPI::MessageBox を呼び出します。
 [引数]
 　doc:HTMLDocument
 　strMsg:メッセージボックスに表示する文字列
 [戻り値]
 　WinAPI::MessageBox の戻り値と同じ

 [long] NilBrowser_MessageBox(HTMLDocument doc,string strTitle,string strMsg)
 [説明]
 　WinAPI::MessageBox を呼び出します。
 [引数]
 　doc:HTMLDocument
 　strTitle:メッセージボックスのタイトル
 　strMsg:メッセージボックスに表示する文字列
 [戻り値]
 　WinAPI::MessageBox の戻り値と同じ

 [long] NilBrowser_MessageBox(HTMLDocument doc,string strTitle,string strMsg,long Flag)
 [説明]
 　WinAPI::MessageBox を呼び出します。
 [引数]
 　doc:HTMLDocument
 　strTitle:メッセージボックスのタイトル
 　strMsg:メッセージボックスに表示する文字列
 　Flag:WinAPI::MessageBox の値と同じ
 [戻り値]
 　WinAPI::MessageBox の戻り値と同じ

NilBrowser_MsgBox

 [long] NilBrowser_MsgBox(HTMLDocument doc,string strMsg)
 [説明]
 　WinAPI::MessageBox を呼び出します。
 [引数]
 　doc:HTMLDocument
 　strMsg:メッセージボックスに表示する文字列
 [戻り値]
 　WinAPI::MessageBox の戻り値と同じ

 [long] NilBrowser_MsgBox(HTMLDocument doc,string strTitle,string strMsg)
 [説明]
 　WinAPI::MessageBox を呼び出します。
 [引数]
 　doc:HTMLDocument
 　strTitle:メッセージボックスのタイトル
 　strMsg:メッセージボックスに表示する文字列
 [戻り値]
 　WinAPI::MessageBox の戻り値と同じ

 [long] NilBrowser_MsgBox(HTMLDocument doc,string strTitle,string strMsg,long Flag)
 [説明]
 　WinAPI::MessageBox を呼び出します。
 [引数]
 　doc:HTMLDocument
 　strTitle:メッセージボックスのタイトル
 　strMsg:メッセージボックスに表示する文字列
 　Flag:WinAPI::MessageBox の値と同じ
 [戻り値]
 　WinAPI::MessageBox の戻り値と同じ

NilBrowser_GetClipString

 [string] NilBrowser_GetClipString(HTMLDocument doc)
 [説明]
 　クリップボードの文字列を取り出します。
 [引数]
 　doc:HTMLDocument
 [戻り値]
 　クリップボードの文字列

NilBrowser_SetClipString

 [void] NilBrowser_SetClipString(HTMLDocument doc,string str)
 [説明]
 　クリップボードに文字列をセットします。
 [引数]
 　doc:HTMLDocument
 　str:クリップボードにコピーする文字列
 [戻り値]
 　なし

NilBrowser_Sprintf

 [string] NilBrowser_Sprintf(HTMLDocument doc,string format, ...)
 [説明]
 　sprintf互換
 　書式にしたがって文字列を形成します。
 [引数]
 　doc:HTMLDocument
 　format:書式
 　...:値

 [戻り値]
 　変換後の文字列
 [例]
 　var str = window.external.NilBrowser_Sprintf(document,"選択されたのは、%d%s%s",10,"番目","です。");
 　alert(str);
 　実行結果：選択されたのは、10番目です。

NilBrowser_EncodeSJIS

 [string] NilBrowser_EncodeSJIS(HTMLDocument doc,string format)
 [説明]
 　URLエンコードをShift-JISで行います。
 [引数]
 　doc:HTMLDocument
 　format:値

 [戻り値]
 　変換後の文字列
 [例]
 　var str = window.external.NilBrowser_EncodeSJIS(document,"エンコード");
 　alert(str);
 　実行結果：%83G%83%93%83R%81%5B%83h

NilBrowser_EncodeEUC

 [string] NilBrowser_EncodeEUC(HTMLDocument doc,string format)
 [説明]
 　URLエンコードをEUCで行います。
 [引数]
 　doc:HTMLDocument
 　format:値

 [戻り値]
 　変換後の文字列
 [例]
 　var str = window.external.NilBrowser_EncodeEUC(document,"エンコード");
 　alert(str);
 　実行結果：%A5%A8%A5%F3%A5%B3%A1%BC%A5%C9

NilBrowser_EncodeUTF8

 [string] NilBrowser_EncodeUTF8(HTMLDocument doc,string format)
 [説明]
 　URLエンコードをUTF8で行います。
 [引数]
 　doc:HTMLDocument
 　format:値

 [戻り値]
 　変換後の文字列
 [例]
 　var str = window.external.NilBrowser_EncodeUTF8(document,"エンコード");
 　alert(str);
 　実行結果：%E3%82%A8%E3%83%B3%E3%82%B3%E3%83%BC%E3%83%89