ConvertTo-OfficePdfOptimized

Namespace PSWriteOffice

Inputs

System.String

Outputs

System.IO.FileInfo OfficeIMO.Pdf.PdfOptimizationActionResult

Source

Sources/PSWriteOffice/Cmdlets/Pdf/ConvertToOfficePdfOptimizedCommand.cs:15 Edit on GitHub

Applies lossless PDF optimization actions and writes a new PDF.

Remarks

Applies lossless PDF optimization actions and writes a new PDF.

Examples

Authored help example

Optimize a PDF with lossless stream compression.

PS>


ConvertTo-OfficePdfOptimized -Path .\Report.pdf -OutputPath .\Report-Optimized.pdf

Writes a smaller PDF when safe lossless optimization actions can reduce the file size.

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

ConvertTo-OfficePdfOptimized [-AllowLarger] [-KeepDuplicateStreams] [-KeepUnreferencedObjects] [-MinimumStreamCompressionBytes <Int32>] [-NoCompressStreams] -OutputPath <String> [-PassThruReport] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AllowLarger SwitchParameter optionalposition: namedpipeline: False: Write the optimized candidate even when it is not smaller than the source PDF.
KeepDuplicateStreams SwitchParameter optionalposition: namedpipeline: False: Keep byte-identical stream objects instead of rewriting duplicate references to one object.
KeepUnreferencedObjects SwitchParameter optionalposition: namedpipeline: False: Keep orphaned indirect PDF objects instead of pruning objects unreachable from the catalog.
MinimumStreamCompressionBytes Int32 optionalposition: namedpipeline: False: Minimum unfiltered stream size considered for compression.
NoCompressStreams SwitchParameter optionalposition: namedpipeline: False: Skip Flate compression of unfiltered streams.
OutputPath String requiredposition: 1pipeline: False: Output PDF path.
PassThruReport SwitchParameter optionalposition: namedpipeline: False: Return the optimization action report instead of the output file.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: Input PDF path.

Outputs

System.IO.FileInfo OfficeIMO.Pdf.PdfOptimizationActionResult