Cmdlet

Set-OfficePdfPageSetup

Aliases: PdfPageSetup

Module: PSWriteOffice
Aliases: PdfPageSetup
Inputs: OfficeIMO.Pdf.PdfDocument
Outputs: OfficeIMO.Pdf.PdfDocument
Source: SetOfficePdfPageSetupCommand.cs:21 Edit on GitHub

Sets PDF page size, orientation, and margins.

Syntax

Set-OfficePdfPageSetup
[-Bottom <Double>]
[-Height <Double>]
[-Landscape]
[-Left <Double>]
[-Margin <Double>]
[-PageSize <String>]
[-PassThru]
[-Right <Double>]
[-Top <Double>]
[-Width <Double>]
[<CommonParameters>]

Parameter set: Context

Set-OfficePdfPageSetup
[-Bottom <Double>]
-Document <PdfDocument>
[-Height <Double>]
[-Landscape]
[-Left <Double>]
[-Margin <Double>]
[-PageSize <String>]
[-PassThru]
[-Right <Double>]
[-Top <Double>]
[-Width <Double>]
[<CommonParameters>]

Parameter set: Document

Examples

Set page size and margins for a generated report.

New-OfficePdf -Path .\Examples\Documents\PdfPageSetup.pdf {
    Set-OfficePdfPageSetup -PageSize A4 -Margin 42
    Add-OfficePdfHeading -Text 'A4 report'
    Add-OfficePdfParagraph -Text 'The report uses custom margins.'
}

Applies page setup before adding generated PDF content.

Parameters

-Bottom Double optional: Bottom margin in PDF points.
-Height Double optional: Custom page height in PDF points when -PageSize Custom is used.
-Landscape SwitchParameter optional: Use landscape orientation.
-Left Double optional: Left margin in PDF points.
-Margin Double optional: Uniform margin in PDF points.
-PageSize String optional: Page size name: A4, A5, Letter, Legal, or Custom.
-PassThru SwitchParameter optional: Emit the updated document.
-Right Double optional: Right margin in PDF points.
-Top Double optional: Top margin in PDF points.
-Width Double optional: Custom page width in PDF points when -PageSize Custom is used.
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document: Compatibility parameter. Page composition is supported only inside New-OfficePdf.

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.