Cmdlet

Add-OfficePdfPageBreak

Aliases: PdfPageBreak

Module PSWriteOffice

Aliases

PdfPageBreak

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

AddOfficePdfPageBreakCommand.cs:22 Edit on GitHub

Adds a page break to a PDF document.

Syntax

Add-OfficePdfPageBreak [-PassThru] [<CommonParameters>]

Parameter set: Context

Add-OfficePdfPageBreak -Document <PdfDocument> [-PassThru] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Start an appendix on a new page.

New-OfficePdf -Path .\Examples\Documents\PdfPageBreak.pdf {
    Add-OfficePdfHeading -Text 'Service review'
    Add-OfficePdfParagraph -Text 'Summary content stays on the first page.'
    Add-OfficePdfPageBreak
    Add-OfficePdfHeading -Text 'Appendix' -Level 2
}

Forces the appendix section to begin on the next page.

Parameters

-PassThru SwitchParameter optional: Emit the updated document.
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document: PDF document to update outside the DSL context.

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.