Cmdlet

Export-OfficePdfLayoutOverlay

Module PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Source

ExportOfficePdfLayoutOverlayCommand.cs:17 Edit on GitHub

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

Syntax

Export-OfficePdfLayoutOverlay [-Format <Png|Svg>] [-IgnorePermissionRestrictions] [-LayoutOptions <PdfTextLayoutOptions>] [-Options <PdfLayoutDebugOverlayOptions>] [-OutputPath] <String> [-Page <Int32>] [-PassThru] [-Password <String>] [-Path] <String> [-ReadOptions <PdfLoadOptions>] [-Scale <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Export an SVG layout overlay for the first page.

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

Parameters

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

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.