Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

View on GitHub Releases Get package
Stars 159
Forks 14
PowerShell Gallery downloads 158,661
Release v3.0.5
Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Export-OfficePdfLayoutOverlay

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Drawing.OfficeImageExportResult
Source
Sources/PSWriteOffice/Cmdlets/Pdf/ExportOfficePdfLayoutOverlayCommand.cs:17 Edit on GitHub

Exports PDF word, line, region, and reading-order diagnostics as PNG or SVG.

Remarks

Exports PDF word, line, region, and reading-order diagnostics as PNG or SVG.

Examples

Authored help example

Export an SVG layout overlay for the first page.

PS>


$result = Export-OfficePdfLayoutOverlay -Path .\Report.pdf -OutputPath .\Report-layout.svg -Page 1 -Format Svg -PassThru

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Export-OfficePdfLayoutOverlay [-Format <Png|Svg>] [-IgnorePermissionRestrictions] [-LayoutOptions <PdfTextLayoutOptions>] [-Options <PdfLayoutDebugOverlayOptions>] -OutputPath <String> [-Page <Int32>] [-PassThru] [-Password <String>] -Path <String> [-ReadOptions <PdfReadOptions>] [-Scale <Double>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 2
Output image format. Layout overlays support only PNG and SVG.
Possible values: Png, Svg
IgnorePermissionRestrictions SwitchParameter optionalposition: namedpipeline: False
After successful password authentication, explicitly ignore owner-imposed extraction restrictions.
LayoutOptions PdfTextLayoutOptions optionalposition: namedpipeline: False
Optional text layout settings.
Options PdfLayoutDebugOverlayOptions optionalposition: namedpipeline: False
Optional overlay elements, colors, and limits.
OutputPath String requiredposition: 1pipeline: False
Destination PNG or SVG path.
Page Int32 optionalposition: namedpipeline: False
One-based page number.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the structured image export result.
Password String optionalposition: namedpipeline: False
Password used to authenticate an encrypted PDF.
Path String requiredposition: 0pipeline: False
Source PDF path.
ReadOptions PdfReadOptions optionalposition: namedpipeline: False
Optional bounded PDF parsing settings.
Scale Double optionalposition: namedpipeline: False
Output scale.

Outputs

OfficeIMO.Drawing.OfficeImageExportResult