mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-03 09:46:54 +02:00
## Summary of the Pull Request - Add the ability for users and admins (GPO) to control whether to display built in New on the context menu. - Changes to the setting are immediately reflected in the experience. - Built-in New is restored on uninstall. ## PR Checklist Note: Supersedes https://github.com/microsoft/PowerToys/pull/39843 - [x] **Closes**: [New+] Replace default New entry #37545 and Replace "New" with New+ option #37946 - [x] **Communication:** Discussed with @niels9001 - 1/22/2025 - [x] **Tests:** Completed manual test pass see highlight below - [x] **Localization:** All end-user-facing strings can be localized - [x] **Dev docs:** Updated "doc\devdocs\modules\newplus.md" - [n/a] **New binaries:** Added on the required places - [n/a] [JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries - [x] [WXS for installer] Updated installer (uninstall custom action) - [n/a] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects - [n/a] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml) - [No] **Documentation updated:** Pending, coming soon. (original PR https://github.com/MicrosoftDocs/windows-dev-docs/pull/5473) ## Detailed Description of the Pull Request / Additional comments Added the ability for users' admins' to display Windows built-in New or not I'm NOT aware of an official supported way to do this, so I'm achieving this by adding an invalid context menu handler in place of New in the Computer\HKEY_CURRENT_USER\Software\Classes\Directory\background\ShellEx\ContextMenuHandlers\New Changes are immediate, after applying the change, built-in New is shown/hidden accordingly Updates to New+ Settings UI New setting introduced to track user' preference (saved to newplus/settings.json) GPO setting introduced for control New visibility via GPO (GPO wins over user preference) Updates to New+ power_module.cpp When runner is running new plus will also apply built-in New admin GPO and user preference (GPO wins over user preference) to ensure correct behavior on setting restore and GPO application. Updates to installer Uninstall always reenable built-in "New" context menu Updated DevDoc Added a note on how to manually restore built-in New ## Validation Steps Performed Windows 11 x64 Settings UI New+ enabled New+ disabled GPO setting enabled GPO settings disabled Manually updating newplus/settings.json Windows 11 ARM64 I tested the reg hack manually, but didn't go through a full pass. Windows 10 x64 NOT tested. Windows 11, Settings, New+ Disabled and no GPO <img width="1040" height="1002" alt="image" src="https://github.com/user-attachments/assets/1b827b10-f009-4b0b-954f-d9311d40d201" /> Windows 11, Settings, New+ Enabled and no GPO <img width="1015" height="781" alt="image" src="https://github.com/user-attachments/assets/a5fa09d3-7fd3-4830-99a4-5f2ac9ce1a38" /> Hide built-in New: Off (the default) <img width="321" height="417" alt="image" src="https://github.com/user-attachments/assets/355fea60-bbb8-4f11-b648-291aaf0c4a6d" /> Hide built-in New: On <img width="1015" height="87" alt="image" src="https://github.com/user-attachments/assets/e83e45c4-6b67-443b-b045-26e7dda2cf46" /> Modern <img width="308" height="360" alt="image" src="https://github.com/user-attachments/assets/b164b240-6e67-410c-8481-7db3ee3225b7" /> Classic <img width="308" height="289" alt="image" src="https://github.com/user-attachments/assets/e2b6c262-a311-454c-9c76-40cb11ff2970" /> Disabling New+ also unhide New <img width="1031" height="569" alt="image" src="https://github.com/user-attachments/assets/29b8dae7-8190-4e64-b106-c6861e472a3d" /> <img width="308" height="353" alt="image" src="https://github.com/user-attachments/assets/e1977d6b-dc85-4db4-b9ab-c7bb2b27dde2" /> Windows 11, Settings, New+ Enabled and with GPO Hide built-in New: GPO enabled <img width="1020" height="691" alt="image" src="https://github.com/user-attachments/assets/75053ab8-92c6-4d38-b1b8-9b0d8293c207" /> Hide built-in New: GPO disabled <img width="1050" height="161" alt="image" src="https://github.com/user-attachments/assets/1a50b841-ff01-4662-a923-aee63717c834" />
150 lines
6.5 KiB
Markdown
150 lines
6.5 KiB
Markdown
# NewPlus Module
|
|
|
|
[Public overview - Microsoft Learn](https://learn.microsoft.com/en-us/windows/powertoys/newplus)
|
|
|
|
## Quick Links
|
|
|
|
[All Issues](https://github.com/microsoft/PowerToys/issues?q=is%3Aopen%20label%3AProduct-New%2B)<br>
|
|
[Bugs](https://github.com/microsoft/PowerToys/issues?q=is%3Aopen%20label%3AIssue-Bug%20label%3AProduct-New%2B)<br>
|
|
[Pull Requests](https://github.com/microsoft/PowerToys/pulls?q=is%3Apr+is%3Aopen+label%3AProduct-New%2B+)
|
|
|
|
## Overview
|
|
|
|
NewPlus is a PowerToys module that provides a context menu entry for creating new files directly from File Explorer. Unlike some other modules, NewPlus implements a different approach to context menu registration to avoid duplication issues in Windows 11.
|
|
|
|
## Context Menu Implementation
|
|
|
|
NewPlus implements two separate context menu handlers:
|
|
|
|
1. **Windows 10 Handler** (`NewPlus.ShellExtension.win10.dll`)
|
|
- Implements "old-style" context menu handler for Windows 10 compatibility
|
|
- Not shown in Windows 11 (this is intentional and controlled by a condition in `QueryContextMenu`)
|
|
- Registered via registry keys
|
|
|
|
2. **Windows 11 Handler** (`NewPlus.ShellExtension.dll`)
|
|
- Implemented as a sparse MSIX package for Windows 11's modern context menu
|
|
- Only registered and used on Windows 11
|
|
|
|
This implementation differs from some other modules like ImageResizer which register both handlers on Windows 11, resulting in duplicate menu entries. NewPlus uses selective registration to provide a cleaner user experience, though it can occasionally lead to issues if the Windows 11 handler fails to register properly.
|
|
|
|
## Project Structure
|
|
|
|
- **NewPlus.ShellExtension** - Windows 11 context menu handler implementation
|
|
- **NewPlus.ShellExtension.win10** - Windows 10 "old-style" context menu handler implementation
|
|
|
|
## Debugging NewPlus Context Menu Handlers
|
|
|
|
### Debugging the Windows 10 Handler
|
|
|
|
1. Update the registry to point to your debug build:
|
|
```
|
|
Windows Registry Editor Version 5.00
|
|
|
|
[HKEY_CLASSES_ROOT\CLSID\{<NewPlus-CLSID>}]
|
|
@="PowerToys NewPlus Extension"
|
|
|
|
[HKEY_CLASSES_ROOT\CLSID\{<NewPlus-CLSID>}\InprocServer32]
|
|
@="x:\GitHub\PowerToys\x64\Debug\PowerToys.NewPlusExt.win10.dll"
|
|
"ThreadingModel"="Apartment"
|
|
|
|
[HKEY_CURRENT_USER\Software\Classes\Directory\Background\shellex\ContextMenuHandlers\NewPlus]
|
|
@="{<NewPlus-CLSID>}"
|
|
```
|
|
|
|
2. Restart Explorer:
|
|
```
|
|
taskkill /f /im explorer.exe && start explorer.exe
|
|
```
|
|
|
|
3. Attach the debugger to explorer.exe
|
|
4. Add breakpoints in the NewPlus code
|
|
5. Right-click in File Explorer to trigger the context menu handler
|
|
|
|
### Debugging the Windows 11 Handler
|
|
|
|
Debugging the Windows 11 handler requires signing the MSIX package:
|
|
|
|
1. Build PowerToys to get the MSIX packages
|
|
|
|
2. **Create certificate** (if you don't already have one):
|
|
```powershell
|
|
New-SelfSignedCertificate -Subject "CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US" `
|
|
-KeyUsage DigitalSignature `
|
|
-Type CodeSigningCert `
|
|
-FriendlyName "PowerToys SelfCodeSigning" `
|
|
-CertStoreLocation "Cert:\CurrentUser\My"
|
|
```
|
|
|
|
3. **Get the certificate thumbprint**:
|
|
```powershell
|
|
$cert = Get-ChildItem -Path Cert:\CurrentUser\My | Where-Object { $_.FriendlyName -like "*PowerToys*" }
|
|
$cert.Thumbprint
|
|
```
|
|
|
|
4. **Install the certificate in the Trusted Root** (requires admin Terminal):
|
|
```powershell
|
|
Export-Certificate -Cert $cert -FilePath "$env:TEMP\PowerToysCodeSigning.cer"
|
|
Import-Certificate -FilePath "$env:TEMP\PowerToysCodeSigning.cer" -CertStoreLocation Cert:\LocalMachine\Root
|
|
```
|
|
|
|
Alternatively, you can manually install the certificate using the Certificate Import Wizard:
|
|
|
|

|
|

|
|

|
|

|
|
|
|
5. Sign the MSIX package:
|
|
```powershell
|
|
SignTool sign /fd SHA256 /sha1 <THUMBPRINT> "x:\GitHub\PowerToys\x64\Debug\WinUI3Apps\NewPlusPackage.msix"
|
|
```
|
|
|
|
Note: SignTool might not be in your PATH, so you may need to specify the full path, e.g.:
|
|
```powershell
|
|
& "C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x64\signtool.exe" sign /fd SHA256 /sha1 <THUMBPRINT> "x:\GitHub\PowerToys\x64\Debug\WinUI3Apps\NewPlusPackage.msix"
|
|
```
|
|
|
|
6. Check if the NewPlus package is already installed and remove it if necessary:
|
|
```powershell
|
|
Get-AppxPackage -Name Microsoft.PowerToys.NewPlusContextMenu
|
|
Remove-AppxPackage Microsoft.PowerToys.NewPlusContextMenu_<VERSION>_neutral__8wekyb3d8bbwe
|
|
```
|
|
|
|
7. Install the new signed MSIX package (optional if launching PowerToys settings first):
|
|
```powershell
|
|
Add-AppxPackage -Path "x:\GitHub\PowerToys\x64\Debug\WinUI3Apps\NewPlusPackage.msix" -ExternalLocation "x:\GitHub\PowerToys\x64\Debug\WinUI3Apps"
|
|
```
|
|
|
|
Note: If you prefer, you can simply launch PowerToys settings and enable the NewPlus module, which will install the MSIX package for you.
|
|
|
|
8. Restart Explorer to ensure the new context menu handler is loaded:
|
|
```powershell
|
|
taskkill /f /im explorer.exe && start explorer.exe
|
|
```
|
|
|
|
9. Run Visual Studio as administrator (optional)
|
|
|
|
10. Set breakpoints in the code (e.g., in [shell_context_menu.cpp#L45](/src/modules/NewPlus/NewShellExtensionContextMenu/shell_context_menu.cpp#L45))
|
|
|
|
11. Right-click in File Explorer and attach the debugger to the `DllHost.exe` process (with NewPlus title) that loads when the context menu is invoked
|
|

|
|
|
|
12. Right-click again (quickly) after attaching the debugger to trigger the breakpoint
|
|
|
|
Note: The DllHost process loads the DLL only when the context menu is triggered and unloads after, making debugging challenging. For easier development, consider using logging or message boxes instead of breakpoints.
|
|
|
|
## Common Issues
|
|
|
|
- If the Windows 11 context menu entry doesn't appear, it may be due to:
|
|
- The package not being properly registered
|
|
- Explorer not being restarted after registration
|
|
- A signature issue with the MSIX package
|
|
|
|
- For development and testing, using the Windows 10 handler can be easier since it doesn't require signing.
|
|
|
|
## Restoring Built-in Windows New context menu
|
|
If the Windows 11 built-in New context menu doesn't reappear on uninstalling PowerToys, some issue with settings etc. here's how to restore the built-in New context menu.
|
|
|
|
1. Open Registry Editor
|
|
1. Go to the key "Computer\HKEY_CURRENT_USER\Software\Classes\Directory\background\ShellEx\ContextMenuHandlers"
|
|
1. Delete the "New" subkey (i.e. fullpath "Computer\HKEY_CURRENT_USER\Software\Classes\Directory\background\ShellEx\ContextMenuHandlers\New") |