mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-03 09:46:54 +02:00

Files

Gijs Reijn 3b6453c932 Improve DSC documentation (#42554 )

<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request

This documentation enhances the DSC documentation by incorporating
reference documents and providing examples.

Closes #42552.

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [x] Closes: #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [ ] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx

<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments

<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed

---------

Co-authored-by: Niels Laute <niels.laute@live.nl>

2026-04-01 16:56:40 +08:00

4.0 KiB

Raw Blame History

description, ms.date, ms.topic, title

description	ms.date	ms.topic	title
DSC configuration reference for PowerToys RegistryPreview module	10/18/2025	reference	RegistryPreview Module

RegistryPreview Module

Synopsis

Manages configuration for the Registry Preview utility, which visualizes and edits Windows registry files (.reg).

Description

The RegistryPreview module configures PowerToys Registry Preview, a utility that provides a visual preview and editing interface for Windows registry (.reg) files. It helps you understand and safely edit registry files before applying them to your system.

Properties

The RegistryPreview module supports the following configurable properties:

DefaultRegApp

Controls whether Registry Preview is set as the default application for .reg files.

Type: boolean
Default: false

Examples

Example 1 - Set as default .reg handler with direct execution

This example sets Registry Preview as the default application for .reg files.

$config = @{
    settings = @{
        properties = @{
            DefaultRegApp = $true
        }
        name = "RegistryPreview"
        version = "1.0"
    }
} | ConvertTo-Json -Depth 10 -Compress

PowerToys.DSC.exe set --resource 'settings' --module RegistryPreview --input $config

Example 2 - Configure with DSC

This example configures Registry Preview as the default handler.

dsc config set --file registrypreview-default.dsc.yaml

# registrypreview-default.dsc.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Set Registry Preview as default
    type: Microsoft.PowerToys/RegistryPreviewSettings
    properties:
      settings:
        properties:
          DefaultRegApp: true
        name: RegistryPreview
        version: 1.0

Example 3 - Install and configure with WinGet

This example installs PowerToys and sets Registry Preview as the default .reg handler.

winget configure winget-registrypreview.yaml

# winget-registrypreview.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
metadata:
  winget:
    processor: dscv3
resources:
  - name: Install PowerToys
    type: Microsoft.WinGet.DSC/WinGetPackage
    properties:
      id: Microsoft.PowerToys
      source: winget
  
  - name: Configure Registry Preview
    type: Microsoft.PowerToys/RegistryPreviewSettings
    properties:
      settings:
        properties:
          DefaultRegApp: true
        name: RegistryPreview
        version: 1.0

Example 4 - Disable as default handler

This example ensures Registry Preview is not the default .reg handler.

dsc config set --file registrypreview-notdefault.dsc.yaml

# registrypreview-notdefault.dsc.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
  - name: Do not use as default
    type: Microsoft.PowerToys/RegistryPreviewSettings
    properties:
      settings:
        properties:
          DefaultRegApp: false
        name: RegistryPreview
        version: 1.0

Use cases

System administration

Configure as default for safe registry file handling:

resources:
  - name: Admin configuration
    type: Microsoft.PowerToys/RegistryPreviewSettings
    properties:
      settings:
        properties:
          DefaultRegApp: true
        name: RegistryPreview
        version: 1.0

Optional tool

Keep as optional tool without default file association:

resources:
  - name: Optional tool
    type: Microsoft.PowerToys/RegistryPreviewSettings
    properties:
      settings:
        properties:
          DefaultRegApp: false
        name: RegistryPreview
        version: 1.0

4.0 KiB Raw Blame History