Tablacus Explorer Script Reference (Index)
A collection of references for the objects available to Tablacus Explorer scripts.
日本語: index_jp.md
Getting Started
- Start with te (getting controls, events) and api (Windows API) to get the big picture.
- Each object you obtain with
te.Ctrl()and similar calls has its own reference.
Find by Goal
| I want to… | See |
|---|---|
| Get the current view or tab | te, FolderView (ShellBrowser), TabCtrl |
| Navigate to a folder / open in a new tab | FolderView (ShellBrowser) |
| Get the paths of the selected files | FolderView (ShellBrowser), FolderItems, FolderItem |
| Change the folder tree display or root | TreeView |
| Execute drag-and-drop operations on files or folders | DropTarget |
Receive events (te.OnXxx) |
te |
| Call the Win32 API | api, Memory |
Work with structures and buffers such as RECT / POINT |
Memory |
| Show a context menu or execute its commands | ContextMenu |
| Show an open / save dialog | CommonDialog |
| Show a progress dialog | ProgressDialog |
| Load, thumbnail, or save an image | WICBitmap |
| Enumerate a COM collection | Enum |
| Open an HTML page or a sub-window | WebBrowser |
All References
Basics (global objects)
| Reference | How to obtain / target | Overview |
|---|---|---|
| te | te |
The global object used across scripts. Getting controls (te.Ctrl / te.Ctrls / te.CreateCtrl), creating objects, events (te.OnXxx), and constants. |
| api | api (= te.WindowsAPI) |
Functions centered on the Win32 API (objects, strings, files, shell, windows, menus, GDI, and more). |
Views, trees, tabs, and browsers
| Reference | How to obtain / target | Overview |
|---|---|---|
| FolderView (ShellBrowser) | te.Ctrl(CTRL_FV) |
The file view (ShellBrowser). Navigation, getting and selecting items, columns / sorting / filtering, and controlling search result views. |
| TabCtrl | te.Ctrl(CTRL_TC) |
The tab control. Getting, selecting, moving, and reordering tabs; position, size, and style. |
| TreeView | FV.TreeView |
The folder tree. Display and root settings, selection and expansion, hit testing, and shell change notifications. |
| WebBrowser | te.Ctrl(CTRL_WB) |
The web browser control embedded in the main window and sub-windows. OnClose and close handling, and passing arguments to sub-windows. |
Items and Operations
| Reference | How to obtain / target | Overview |
|---|---|---|
| FolderItem | FV.FolderItem, etc. |
A single file, folder, or virtual-folder item. Path and name, and the standard Windows FolderItem members. |
| FolderItems | FV.SelectedItems(), etc. |
A collection of FolderItem. It also behaves as an IDataObject, so it can be passed to drag and drop and the clipboard. |
| DropTarget | api.DropTarget(item) / FV.Droptarget |
Object that allows executing drag-and-drop operations (IDropTarget) on files or folders via script. |
Menus and dialogs
| Reference | How to obtain / target | Overview |
|---|---|---|
| ContextMenu | api.ContextMenu() |
The shell context menu (IContextMenu). Creating menus, executing commands, and related events. |
| CommonDialog | api.CreateObject("CommonDialog") |
The "Open" and "Save As" dialogs. Filters and folder selection (OFN_ENABLEHOOK). |
| ProgressDialog | api.CreateObject("ProgressDialog") |
The standard shell progress dialog. Progress bar, text lines, and cancel detection. |
Utilities
| Reference | How to obtain / target | Overview |
|---|---|---|
| Enum | api.CreateObject("Enum", collection) |
Enumerates a COM collection one element at a time (equivalent to JScript's Enumerator). Can also enumerate member names. |
| Memory | api.Memory() |
Native memory (structures and buffers). Includes the field list of Win32 structures such as RECT, POINT, and LOGFONT. |
| WICBitmap | api.CreateObject("WICBitmap") |
Loading, converting, drawing, and saving images (Windows Imaging Component). |
Common Conventions
- Notation: see the
> Notation:line at the top of each file (P = property, M = method). - Needs verification: points that could not be confirmed from the implementation are marked "needs verification".
- Asynchronous scripts: in WebView2-side scripts such as
ui.js, calls requireawait(also noted in each reference). - Creating objects: other than the
apiobject, basically useapi.CreateObject(...)(see te). - Constants:
SBSP_*,FVM_*,OFN_*, and others are defined inconsts.js.
Chapters of Each Reference
te
- Getting Controls
- Creating Objects
- Script-Wide Data
- Window and Drawing Control
- Numeric Setting Properties
- String Setting Properties
- Events (
te.OnXxx) - Constants
- Members of the Objects Returned by
te.Ctrl - Deprecated / Internal
api
- Objects and Data
- 64-bit Integers
- Strings, Encoding, and Cryptography
- Files and Paths
- Shell (FolderItem/IDList)
- Processes, Threads, and Synchronization
- Windows, Messages, and Input
- Menus
- GDI, Drawing, and Icons
- ImageList
- Others
FolderView (ShellBrowser)
- How to Obtain
- Navigation
- View Mode and Settings
- Getting and Selecting Items
- Columns, Sorting, Grouping, and Filtering
- Windows, Tabs, and Related Objects
- Dynamically Adding and Removing Items (Search Result Views, etc.)
- Customization Properties
- Notification and Internal Methods
- Constants
- Deprecated / Internal
TabCtrl
- How to Obtain
- Basics and Getting Tabs
- Selecting and Operating on Tabs
- Position, Size, and Style
- Controlling Updates
- Constants
- Examples
TreeView
- How to Obtain
- Basics and Display
- Root and Enumeration Settings
- Selection, Expansion, and Operations
- Position, Hit Testing, and Notifications
- Tree-Related Events (For Reference)
- Constants
- Examples
- Legacy Compatibility Members
WebBrowser
- Overview
- How to Obtain
- Methods
- Properties
- Event (OnClose) and Close Handling
- Differences Between the Main Window and Sub-Windows
- Constants
- Examples
FolderItem
- Overview
- How to Obtain
- Tablacus Explorer-Specific Members
- Members Compatible with the Standard Windows FolderItem
- Standard Windows FolderItem Members (Delegated)
- Additional Notes
- Examples
FolderItems
DropTarget
ContextMenu
CommonDialog
ProgressDialog
Enum
Memory
- How to Obtain
- Common Members
- Read / Write and VT Constants
- Structure Fields
- Primitive-Type Memory
- Notes
- Examples