API Reference

Cmdlet

Join-OfficePdf

Namespace PSWriteOffice
Inputs
None
Outputs
System.IO.FileInfo

Joins multiple PDF files into a single PDF.

Remarks

Joins multiple PDF files into a single PDF.

Examples

Authored help example

Join two PDFs in order.

PS>


$cover = '.\Examples\Documents\Cover.pdf'
            $report = '.\Examples\Documents\Report.pdf'
            Join-OfficePdf -Path $cover, $report -OutputPath .\Examples\Documents\Combined.pdf -PassThru
            Get-OfficePdfInfo -Path .\Examples\Documents\Combined.pdf | Select-Object PageCount
        

Writes a single PDF containing the input documents in the requested order, then checks the result.

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

Join-OfficePdf [-FlattenVisualAnnotations] [-Height <Nullable`1>] [-Landscape] -OutputPath <String> [-PageSize <String>] [-PassThru] -Path <String[]> [-ResizeMargin <Nullable`1>] [-ResizeMode <Fit|Fill|Stretch>] [-Width <Nullable`1>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

FlattenVisualAnnotations SwitchParameter optionalposition: namedpipeline: False
Flatten visual annotation appearances before merging.
Height Nullable`1 optionalposition: namedpipeline: False
Custom output page height in points when -PageSize Custom is used.
Landscape SwitchParameter optionalposition: namedpipeline: False
Use the landscape orientation of the selected output page size.
OutputPath String requiredposition: 1pipeline: False
Output PDF path.
PageSize String optionalposition: namedpipeline: False
Resize each merged page to a known OfficeIMO page size such as A4, Letter, or Custom.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the saved file.
Path String[] requiredposition: 0pipeline: Falsealiases: FilePath
Input PDF paths in output order.
ResizeMargin Nullable`1 optionalposition: namedpipeline: False
Margin, in points, reserved around resized page content.
ResizeMode PdfPageResizeMode optionalposition: namedpipeline: Falsevalues: 3
How source page content is fitted into the resized output page.
Possible values: Fit, Fill, Stretch
Width Nullable`1 optionalposition: namedpipeline: False
Custom output page width in points when -PageSize Custom is used.

Outputs

System.IO.FileInfo