WebBrowser リファレンス

Tablacus Explorer のメインウィンドウ、およびサブウィンドウ(オプション画面やダイアログ)に埋め込まれた Web ブラウザコントロール(CTRL_WB / CTRL_SW)のリファレンスです。

• 関連: te リファレンス(te.Ctrl / te.CreateCtrl(CTRL_SW, ...) / te.Arguments)、api リファレンス、FolderView(ShellBrowser)リファレンス
• 作成元: TE/TE.cpp の methodWB[] と CteWebBrowser(コンストラクタ、Invoke、Close)、サブウィンドウのウィンドウプロシージャ WndProc2 の実装

記法: P=プロパティ、M=メソッド。メンバー名の照合は大文字小文字を区別しません。

目次

1. 概要
2. 取得方法
3. メソッド
4. プロパティ
5. イベント(OnClose)と閉じる処理
6. メインウィンドウとサブウィンドウの違い
7. 定数
8. 使用例

1. 概要

WebBrowser オブジェクトは、HTML ページを表示するウィンドウを表します。内部では次のどちらかが使われます。

どちらの場合も、このオブジェクトの Document や Window を通して、表示中のページの DOM や window オブジェクトにアクセスできます。 読み込まれたページからは、external(= te オブジェクト)経由で TE の機能を呼び出せます。

2. 取得方法

非同期スクリプト(ui.js など WebView2 側)では await te.Ctrl(CTRL_WB) のように await が必要です。

3. メソッド

4. プロパティ

5. イベント(OnClose)と閉じる処理

WebBrowser.OnClose = function (WB) { ... } を設定すると、ユーザーがウィンドウの「閉じる」ボタン(×)などで閉じようとしたとき、すぐには閉じずに、この関数が呼ばれます。関数の中で次のどちらかを行います。

• OnClose が設定されていないサブウィンドウで閉じる操作があったときは、そのまま閉じられます。
• OnClose の呼び出しは、閉じる要求が出たウィンドウ(サブウィンドウ)でのみ行われます。WB.Close() でスクリプトから閉じた場合は、OnClose は呼ばれません。
• OnClose の中では await が使える非同期関数も渡せます(options.js が async function (WB) を使用)。ただし、Close() / PreventClose() は、処理が終わるまで(非同期の確認が終わるまで)呼ばなければ、ウィンドウは閉じられない状態のままになります。
• 閉じる処理のあと、DocumentComplete で空白ページに移動してからウィンドウが破棄される二段階の処理になっています。
• 実際の使用: options.js の InitOptions が、変更があるときに「保存しますか」の確認を出し、ContinueOptions で WebBrowser.PreventClose() を呼んで閉じるのをやめ、CloseWB(WebBrowser, true) で閉じています。ダイアログ系は ReturnDialogResult(結果を返して WB.Close())を OnClose に設定します。

6. メインウィンドウとサブウィンドウの違い

7. 定数

8. 使用例

// 1. サブウィンドウを開く(オプション画面の例に近い形)
const WB = te.CreateCtrl(CTRL_SW, "file:///C:/path/page.html", { name: "value" }, te.hwnd, 600, 400);   // WebBrowser を返す
WB.OnClose = function (WB) {
    // 確認なしで閉じる
    WB.Close();
};

// 2. 閉じる前に確認して、取り消す
WB.OnClose = function (WB) {
    // IDNO = 7 (api.MessageBox の戻り値)
    if (api.MessageBox(te.hwnd, "閉じますか?", TITLE, MB_YESNO) == IDNO) {
        WB.PreventClose();   // 取り消し
        return;
    }
    WB.Close();
};

// 3. ページの DOM を読む
const doc = WB.Document;
const title = doc.title;
const win = WB.Window;
win.alert("hello");

// 4. 開かれたページ側(サブウィンドウ内)
//    te.Arguments はこの値を一度だけ受け取って、クリアする
const args = te.Arguments;
const WebBrowser = te.Ctrl(CTRL_WB);   // 自分自身の WebBrowser
WebBrowser.Close();                    // 自分を閉じる

// 5. メインの WebBrowser(ドロップ先の判定)
te.OnDrop = function (Ctrl, dataObj, pgrfKeyState, pt, pdwEffect) {
    if (Ctrl.Type == CTRL_WB) {
        // アドレスバーなどにドロップされた
    }
};

上の te.CreateCtrl(CTRL_SW, ...) の引数の指定方法は te リファレンス の CreateCtrl の項を参照してください。OnDrop の引数は、sync1.js の実装での並び(Ctrl, dataObj, pgrfKeyState, pt, pdwEffect)に合わせています。TITLE・MB_YESNO・IDNO は consts.js などで定義されているものを使う想定です(要確認)。

関連

• te リファレンス
• api リファレンス
• FolderView(ShellBrowser)リファレンス