mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-04-03 17:56:44 +02:00
<!-- 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>
216 lines
4.9 KiB
Markdown
216 lines
4.9 KiB
Markdown
---
|
|
description: DSC configuration reference for PowerToys ZoomIt module
|
|
ms.date: 10/18/2025
|
|
ms.topic: reference
|
|
title: ZoomIt Module
|
|
---
|
|
|
|
# ZoomIt Module
|
|
|
|
## Synopsis
|
|
|
|
Manages configuration for the ZoomIt utility, which provides screen zoom, annotation, and presentation tools.
|
|
|
|
## Description
|
|
|
|
The `ZoomIt` module configures PowerToys ZoomIt, a screen zoom and annotation utility for presentations and demonstrations. It provides live zoom, screen drawing, a break timer, and other presentation features activated through customizable keyboard shortcuts.
|
|
|
|
## Properties
|
|
|
|
The ZoomIt module supports the following configurable properties:
|
|
|
|
### ActivationShortcut
|
|
|
|
Sets the keyboard shortcut to activate the zoom mode.
|
|
|
|
**Type:** object
|
|
**Properties:**
|
|
|
|
- `win` (boolean) - Windows key modifier
|
|
- `ctrl` (boolean) - Ctrl key modifier
|
|
- `alt` (boolean) - Alt key modifier
|
|
- `shift` (boolean) - Shift key modifier
|
|
- `code` (integer) - Virtual key code
|
|
- `key` (string) - Key name
|
|
|
|
**Default:** `Ctrl+1` (VK code 49)
|
|
|
|
## Examples
|
|
|
|
### Example 1 - Configure activation shortcut with direct execution
|
|
|
|
This example sets a custom keyboard shortcut to activate ZoomIt.
|
|
|
|
```powershell
|
|
$config = @{
|
|
settings = @{
|
|
properties = @{
|
|
ActivationShortcut = @{
|
|
win = $false
|
|
ctrl = $true
|
|
alt = $false
|
|
shift = $true
|
|
code = 90
|
|
key = "Z"
|
|
}
|
|
}
|
|
name = "ZoomIt"
|
|
version = "1.0"
|
|
}
|
|
} | ConvertTo-Json -Depth 10 -Compress
|
|
|
|
PowerToys.DSC.exe set --resource 'settings' --module ZoomIt --input $config
|
|
```
|
|
|
|
### Example 2 - Configure with Microsoft DSC
|
|
|
|
This example configures the ZoomIt activation shortcut using Microsoft DSC.
|
|
|
|
```bash
|
|
dsc config set --file zoomit-config.dsc.yaml
|
|
```
|
|
|
|
```yaml
|
|
# zoomit-config.dsc.yaml
|
|
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
|
|
resources:
|
|
- name: Configure ZoomIt shortcut
|
|
type: Microsoft.PowerToys/ZoomItSettings
|
|
properties:
|
|
settings:
|
|
properties:
|
|
ActivationShortcut:
|
|
win: false
|
|
ctrl: true
|
|
alt: false
|
|
shift: false
|
|
code: 49
|
|
key: "1"
|
|
name: ZoomIt
|
|
version: 1.0
|
|
```
|
|
|
|
### Example 3 - Install and configure with WinGet
|
|
|
|
This example installs PowerToys and configures ZoomIt using WinGet.
|
|
|
|
```bash
|
|
winget configure winget-zoomit.yaml
|
|
```
|
|
|
|
```yaml
|
|
# winget-zoomit.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 ZoomIt
|
|
type: Microsoft.PowerToys/ZoomItSettings
|
|
properties:
|
|
settings:
|
|
properties:
|
|
ActivationShortcut:
|
|
win: false
|
|
ctrl: true
|
|
alt: false
|
|
shift: true
|
|
code: 90
|
|
key: Z
|
|
name: ZoomIt
|
|
version: 1.0
|
|
```
|
|
|
|
### Example 4 - Presentation mode hotkey
|
|
|
|
This example configures an easy-to-remember presentation hotkey.
|
|
|
|
```bash
|
|
dsc config set --file zoomit-presentation.dsc.yaml
|
|
```
|
|
|
|
```yaml
|
|
# zoomit-presentation.dsc.yaml
|
|
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
|
|
resources:
|
|
- name: Presentation hotkey
|
|
type: Microsoft.PowerToys/ZoomItSettings
|
|
properties:
|
|
settings:
|
|
properties:
|
|
ActivationShortcut:
|
|
win: true
|
|
ctrl: false
|
|
alt: false
|
|
shift: false
|
|
code: 187
|
|
key: "="
|
|
name: ZoomIt
|
|
version: 1.0
|
|
```
|
|
|
|
## Use cases
|
|
|
|
### Presentations
|
|
|
|
Configure for easy screen zooming during presentations:
|
|
|
|
```yaml
|
|
resources:
|
|
- name: Presentation setup
|
|
type: Microsoft.PowerToys/ZoomItSettings
|
|
properties:
|
|
settings:
|
|
properties:
|
|
ActivationShortcut:
|
|
win: false
|
|
ctrl: true
|
|
alt: false
|
|
shift: false
|
|
code: 49
|
|
key: "1"
|
|
name: ZoomIt
|
|
version: 1.0
|
|
```
|
|
|
|
### Screen recording
|
|
|
|
Configure for quick access during screen recording sessions:
|
|
|
|
```yaml
|
|
resources:
|
|
- name: Recording setup
|
|
type: Microsoft.PowerToys/ZoomItSettings
|
|
properties:
|
|
settings:
|
|
properties:
|
|
ActivationShortcut:
|
|
win: true
|
|
ctrl: false
|
|
alt: false
|
|
shift: true
|
|
code: 90
|
|
key: Z
|
|
name: ZoomIt
|
|
version: 1.0
|
|
```
|
|
|
|
## See also
|
|
|
|
- [Settings Resource][01]
|
|
- [PowerToys DSC Overview][02]
|
|
- [CropAndLock Module][03] - For additional PowerToys configuration
|
|
- [PowerToys ZoomIt Documentation][04]
|
|
|
|
<!-- Link reference definitions -->
|
|
[01]: ../settings-resource.md
|
|
[02]: ../overview.md
|
|
[03]: ./CropAndLock.md
|
|
[04]: https://learn.microsoft.com/windows/powertoys/zoomit
|