Get-OfficePdfOptimization

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Pdf.PdfOptimizationReport

Source

Sources/PSWriteOffice/Cmdlets/Pdf/GetOfficePdfOptimizationCommand.cs:16 Edit on GitHub

Gets lossless PDF optimization opportunities without modifying the file.

Remarks

Gets lossless PDF optimization opportunities without modifying the file.

Examples

Authored help example

Review optimization candidates.

PS>


$report = Get-OfficePdfOptimization -Path .\Report.pdf
            $report.EstimatedSavingsBytes
            $report.DuplicateStreams

Returns stream and duplicate-object hints before any rewrite operation is attempted.

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

Get-OfficePdfOptimization [-Password <String>] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Password String optionalposition: namedpipeline: False: Password used to analyze a Standard password-encrypted PDF.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: PDF file path.

Outputs

OfficeIMO.Pdf.PdfOptimizationReport