Tablacus Explorer スクリプト リファレンス(目次)
Tablacus Explorer のスクリプトから使えるオブジェクトのリファレンス集です。
English: index_en.md
はじめに
目的から探す
| やりたいこと | 見るリファレンス |
|---|---|
| 現在のビューやタブを取得したい | te、FolderView(ShellBrowser)、TabCtrl |
| フォルダへ移動したい / 新しいタブで開きたい | FolderView(ShellBrowser) |
| 選択中のファイルのパスを取得したい | FolderView(ShellBrowser)、FolderItems、FolderItem |
| フォルダツリーの表示・ルートを変えたい | TreeView |
| ファイルやフォルダへのドロップ操作を実行したい | DropTarget |
イベント(te.OnXxx)を受け取りたい |
te |
| Win32 API を呼びたい | api、Memory |
RECT / POINT などの構造体やバッファを扱いたい |
Memory |
| 右クリックメニューを出したい・コマンドを実行したい | ContextMenu |
| ファイルを開く/保存するダイアログを出したい | CommonDialog |
| 進捗ダイアログを出したい | ProgressDialog |
| 画像を読み込む・サムネイルを作る・保存する | WICBitmap |
| COM コレクションを列挙したい | Enum |
| HTML ページやサブウィンドウを開きたい | WebBrowser |
リファレンス一覧
基本(グローバルオブジェクト)
| リファレンス | 取得方法・対象 | 概要 |
|---|---|---|
| te | te |
スクリプト全体で使うグローバルオブジェクト。コントロールの取得(te.Ctrl / te.Ctrls / te.CreateCtrl)、オブジェクトの生成、イベント(te.OnXxx)、定数。 |
| api | api(= te.WindowsAPI) |
Win32 API を中心とした関数群(オブジェクト・文字列・ファイル・シェル・ウィンドウ・メニュー・GDI など)。 |
ビュー・ツリー・タブ・ブラウザ
| リファレンス | 取得方法・対象 | 概要 |
|---|---|---|
| FolderView(ShellBrowser) | te.Ctrl(CTRL_FV) |
ファイルビュー(ShellBrowser)。ナビゲーション、アイテムの取得・選択、列・ソート・フィルタ、検索結果ビューの制御。 |
| TabCtrl | te.Ctrl(CTRL_TC) |
タブコントロール。タブの取得・選択・移動・並べ替え、位置・サイズ・スタイル。 |
| TreeView | FV.TreeView |
フォルダツリー。表示・ルートの設定、選択・展開、ヒットテスト、シェル変更通知。 |
| WebBrowser | te.Ctrl(CTRL_WB) |
メインウィンドウ/サブウィンドウに埋め込まれた Web ブラウザコントロール。OnClose と閉じる処理、サブウィンドウへの引数渡し。 |
アイテム・操作
| リファレンス | 取得方法・対象 | 概要 |
|---|---|---|
| FolderItem | FV.FolderItem など |
1つのファイル/フォルダ/仮想フォルダ項目。パス・名前、Windows 標準の FolderItem メンバー。 |
| FolderItems | FV.SelectedItems() など |
FolderItem のコレクション。IDataObject としても動作し、ドラッグ&ドロップやクリップボードに渡せる。 |
| DropTarget | api.DropTarget(item) / FV.Droptarget |
ファイルやフォルダへのドロップ操作(IDropTarget)をスクリプトから実行するオブジェクト。 |
メニュー・ダイアログ
| リファレンス | 取得方法・対象 | 概要 |
|---|---|---|
| ContextMenu | api.ContextMenu() |
シェルのコンテキストメニュー(IContextMenu)。メニューの作成・コマンド実行・関連イベント。 |
| CommonDialog | api.CreateObject("CommonDialog") |
「ファイルを開く」「名前を付けて保存」ダイアログ。フィルター、フォルダ選択(OFN_ENABLEHOOK)。 |
| ProgressDialog | api.CreateObject("ProgressDialog") |
シェル標準の進捗ダイアログ。進捗バー・テキスト行・キャンセル判定。 |
ユーティリティ
| リファレンス | 取得方法・対象 | 概要 |
|---|---|---|
| Enum | api.CreateObject("Enum", collection) |
COM コレクションを順に列挙する(JScript の Enumerator 相当)。メンバー名の列挙にも使える。 |
| Memory | api.Memory() |
ネイティブメモリ(構造体・バッファ)。RECT / POINT / LOGFONT など Win32 構造体のフィールド一覧を含む。 |
| WICBitmap | api.CreateObject("WICBitmap") |
画像の読み込み・変換・描画・保存(Windows Imaging Component)。 |
共通の約束
- 記法: 各ファイル冒頭の
> 記法:を参照してください(P=プロパティ、M=メソッド)。 - 要確認: 実装から確認できなかった点は「要確認」と記載しています。
- 非同期スクリプト:
ui.jsなど WebView2 側のスクリプトでは、呼び出しにawaitが必要です(各リファレンスにも記載)。 - オブジェクトの生成:
apiオブジェクト以外は、基本的にapi.CreateObject(...)を使います(te 参照)。 - 定数:
SBSP_*、FVM_*、OFN_*などはconsts.jsで定義されています。
各リファレンスの章
te
- コントロールの取得
- オブジェクトの生成
- スクリプト全体のデータ
- ウィンドウ・描画制御
- 数値設定プロパティ
- 文字列設定プロパティ
- イベント(
te.OnXxx) - 定数
te.Ctrlが返すオブジェクトのメンバー一覧- 廃止・内部用
api
- オブジェクト・データ操作
- 64bit整数
- 文字列・エンコード・暗号
- ファイル・パス
- シェル(FolderItem/IDList)
- プロセス・スレッド・同期
- ウィンドウ・メッセージ・入力
- メニュー
- GDI・描画・アイコン
- ImageList
- その他
FolderView(ShellBrowser)
- 取得方法
- ナビゲーション
- 表示モード・設定
- アイテムの取得・選択
- 列・ソート・グループ・フィルタ
- ウィンドウ・タブ・関連オブジェクト
- アイテムの動的追加・削除(検索結果ビュー等)
- カスタマイズ用プロパティ
- 通知・内部用メソッド
- 定数
- 廃止・内部用
TabCtrl
TreeView
WebBrowser
FolderItem
- 概要
- 取得方法
- Tablacus Explorer 独自メンバー
- Windows 標準の FolderItem 互換のメンバー
- Windows 標準の FolderItem メンバー(委譲)
- 補足
- 使用例