Cmdlet

New-OfficePdfLayoutOverlayOptions

Module: PSWriteOffice
Inputs: None
Outputs: OfficeIMO.Pdf.PdfLayoutDebugOverlayOptions
Source: NewOfficePdfLayoutOverlayOptionsCommand.cs:14 Edit on GitHub

Creates native PDF layout-overlay layers, colors and resource limits.

Syntax

New-OfficePdfLayoutOverlayOptions
[-LineColor <OfficeColor>]
[-MaxElements <Int32>]
[-MaximumRasterPixelCount <Int64>]
[-NoLines]
[-NoReadingOrder]
[-NoRegions]
[-NoWords]
[-RegionColor <OfficeColor>]
[-WordColor <OfficeColor>]
[<CommonParameters>]

Parameter set: Default

Examples

Show paragraph regions and reading order without word or line boxes.

$options = New-OfficePdfLayoutOverlayOptions -NoWords -NoLines -RegionColor '#FF00FF'
Export-OfficePdfLayoutOverlay -Path ./Report.pdf -OutputPath ./Order.svg -Options $options

Parameters

-LineColor OfficeColor optional: Line-box color or theme color role.
-MaxElements Int32 optional: Maximum boxes and labels in one overlay.
-MaximumRasterPixelCount Int64 optional: Maximum allocated pixels in a PNG overlay.
-NoLines SwitchParameter optional: Hide line boxes.
-NoReadingOrder SwitchParameter optional: Hide reading-order labels.
-NoRegions SwitchParameter optional: Hide paragraph region boxes.
-NoWords SwitchParameter optional: Hide word boxes.
-RegionColor OfficeColor optional: Paragraph-region color or theme color role.
-WordColor OfficeColor optional: Word-box color or theme color role.

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.