Skip to content

README.en.md

Latest commit

 

History

History
84 lines (59 loc) · 3.06 KB

README.en.md

File metadata and controls

84 lines (59 loc) · 3.06 KB
Raw

ShellExtContextMenuHandler

English | 简体中文

A configurable context menu module derived from the official Microsoft C++ Shell extension sample. Define menu items, filters, gate/executor chains, and icons in menu.json without changing core COM code.

Based on: CppShellExtContextMenuHandler

Features

  • Registered for all file types (*), with runtime gates controlling visibility
  • Multiple menu items and gate/executor chains via config/menu.json
  • messageBox and launch actions plus custom executors
  • Filters: extension, selection count, files vs folders
  • Folder background context (current directory when nothing is selected)
  • SVG/BMP icons with DPI-aware scaling
  • Built-in demo gates (demo:hideTemp, demo:readOnlyDisable) and demo:actionLog executor
  • Debug logging via OutputDebugString (DebugView)
  • CMake build; GitHub Actions CI for Release build and menu.json validation
  • Layered Gate architecture — see docs/ARCHITECTURE.en.md

Project layout

├── CMakeLists.txt
├── .github/workflows/ci.yml
├── docs/
├── config/menu.json, config/icons/
├── src/extension, context, gates, actions, platform, icons, menu, registry, resources
├── tools/generate-vs.ps1, register.ps1, validate_menu_json.py
└── build/             # generated (gitignored)

Quick start

cmake -S . -B build -G "Visual Studio 18 2026" -A x64
cmake --build build --config Release
python tools/validate_menu_json.py
.\tools\register.ps1 -Action register   # administrator

register.ps1 copies config/menu.json and config/icons/ beside the DLL.

Right-click a .cpp file in Explorer to verify. Full manual checklist: docs/ARCHITECTURE.en.md.

Customize menus

Edit config/menu.json.

Root-level chains (optional)

Field Description
extensionGates Gate 1 chain (default extensionPass)
itemGates Gate 2 chain (default jsonFilter); gates is an alias
presentationGates Gate 3 chain (default presentationPass)
executors Action chain (default messageBox, launch)

Per-item fields

Includes id, label, verb, icon, filter fields, action fields, and optional per-item extensionGates / itemGates / presentationGates / executors overrides.

Placeholders

Token Meaning
%1 First selected path, or current folder
%* All selected paths (quoted)
%D Parent directory

COM identity

When shipping a fork, change CLSID and friendly names in dllmain.cpp and include/shell_ext/common.h.

Notes

  • 64-bit Explorer requires a 64-bit DLL
  • COM registration needs elevation
  • Complete the Win7 SP1 x64 manual checklist in the architecture doc before release

License

Derived from the Microsoft sample (Ms-PL).