Set-OfficePdfPageSetup

Aliases: PdfPageSetup

Namespace PSWriteOffice

Aliases

PdfPageSetup

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

Sources/PSWriteOffice/Cmdlets/Pdf/SetOfficePdfPageSetupCommand.cs:21 Edit on GitHub

Sets PDF page size, orientation, and margins.

Remarks

Sets PDF page size, orientation, and margins.

Examples

Authored help example

Set page size and margins for a generated report.

PS>


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.

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

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

Parameter set: Context

Parameters

Bottom Double optionalposition: namedpipeline: False: Bottom margin in PDF points.
Height Double optionalposition: namedpipeline: False: Custom page height in PDF points when -PageSize Custom is used.
Landscape SwitchParameter optionalposition: namedpipeline: False: Use landscape orientation.
Left Double optionalposition: namedpipeline: False: Left margin in PDF points.
Margin Double optionalposition: namedpipeline: False: Uniform margin in PDF points.
PageSize String optionalposition: namedpipeline: False: Page size name: A4, A5, Letter, Legal, or Custom.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Right Double optionalposition: namedpipeline: False: Right margin in PDF points.
Top Double optionalposition: namedpipeline: False: Top margin in PDF points.
Width Double optionalposition: namedpipeline: False: Custom page width in PDF points when -PageSize Custom is used.

Outputs

OfficeIMO.Pdf.PdfDocument

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

Parameters

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

Outputs

OfficeIMO.Pdf.PdfDocument