Export-OfficePdfLayoutOverlay

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Drawing.OfficeImageExportResult

Source

Sources/PSWriteOffice/Cmdlets/Pdf/ExportOfficePdfLayoutOverlayCommand.cs:10 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

EXAMPLE 1


Export-OfficePdfLayoutOverlay -Path 'C:\Path'

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|Jpeg|Tiff|Webp>] [-LayoutOptions <PdfTextLayoutOptions>] [-Options <PdfLayoutDebugOverlayOptions>] -OutputPath <String> [-Page <Int32>] -Path <String> [-ReadOptions <PdfReadOptions>] [-Scale <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Format OfficeImageExportFormat optionalposition: namedpipeline: Falsevalues: 5: Output image format. Layout overlays support only PNG and SVG.; Possible values: Png, Svg, Jpeg, Tiff, Webp
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.
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