oleg-shilo / shell-x

Dynamic context menu manager for Windows.
146 stars 10 forks source link

Shell-X

paypal

Dynamic customizable file context menu solution for Windows. Allows creating context menus of any complexity without the need to compile COM shell extensions. The solution is based on the same concept as Windows Explorer native "Send to" context menu.

Overview

In Windows Explorer, context menus are an extremely important part of the User Experience (UX). Just a single right-click on the file allows convenient access to the file type-specific operations.

Unfortunately, the creation and customization of context menus were always a pain point. The problem is that Windows implements explorer context menus as so-called Shell Extensions. They are a heavy-weight COM servers that is not trivial to implement. And what is even more important they are components that must be rebuilt/recompiled every time user wants to change the menu structure or the associated menu action. And this in turn dramatically affects the user adoption of context menus as an operating system feature.

Interestingly enough Windows has introduced an alternative light way for managing a very specific context menu - "Send to".

image

The customisation of the "Send to" is dead simple. The user simply goes to the special folder and creates their shortcut(s) to the desired application. Then at runtime, the shortcut name will become the content menu item. And shortcut itself will be invoked (with the selected file path passed as an argument) when the user selects this menu item.

image

This means that the creation and customization of the "Send to" context menu is a simple file creation/editing activity that does not even require user to be an admin (elevated).

Shell-X applies the same simplified approach but extends it by allowing the creation of any context menu for any file type.

Below are some of Shell-X features that extend Windows "Send to" approach:

Note, that intensive use of icons may lead to memory exhaustion. This is a Windows Explorer bug/design flaw. Thus don't overuse this feature. You can read more about this in this therad.

Installation

With Chocolatey

Install package Shell-X:

choco install shell-x

Manually

Configuration

After the installation, the sample context menu (as described in the next section) will be created. Do modify and extend it as you wish by creating properly named batch files in the configuration folder as described in the next section.

You can open the configuration folder at any time by executing the open command in the command prompt:

shell-x -open

There is also an option (v1.4.0+) for testing the configuration outside of the Windows explorer

shell-x -test [path]

It is helpful for refining the mapping of the configuration to the selected item (path) actions.

image

How it works

Shell-X maintains a global directory, whose file tree structure defines the complex context menu tree to be displayed at runtime on right click.

The root folders are named according to the file extension that the context menu is for. Thus the folder txt contains context menu definition for all text files, and the dll folder is for all DLLs. There are special folder names:

Note A, if you want multiple extension files to be handled the same way (by a single handler) you can achieve this by naming the special folder with the comma-separated extension names enclosed in the square brackets. IE for menu item associated with editing JPEG and BMP Files the folder name should be [jpeg,bmp]:

Note B All special folders have their name enclosed in square brackets (e.g. [any] or [txt,md]) and all folders for specific file extension have their names exactly matching the extension text (e.g. txt).

image

Below is an example of the configuration for for text files (txt file extension).

image

This is how the menu for text files looks at runtime.

image

In the example above the context menu for txt files has a complex structure containing sub-menus for opening the selected file with Notepad and other file handling operations.

The content of 00.Notepad.cmd file is an ordinary batch file content:

notepad.exe %*

Since the menu items are composed according to the configuration folder file structure naming the files it is vital the proper naming convention is followed:

Note, you can use wild card expression as the folder name that encodes the pattern for the file name (of the file that is right-clicked). However, since the wild card characters are prohibited by the file system you will need to use special characters that look like the special wild card characters but are in fact special Unicode characters that are safe to use as folder names:

// The Unicode characters that look like ? and * but still allowed in dir and file names
 string safeQuestionMark = "?"; 
 string safeAsterisk = "⁎";

Simply copy the characters from this description, compose the desired pattern in the text editor and then paste the pattern in the file explorer as a folder name.

Thus your desired pattern for files cmn.ar.00, cmn.ar.01,. . . will look like this: ⁎.ar.⁎.

Naming Convention

The naming convention for configuration folders:

Limitations