Add-OfficePdfPageBreak

Aliases: PdfPageBreak

Namespace PSWriteOffice

Aliases

PdfPageBreak

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

Sources/PSWriteOffice/Cmdlets/Pdf/AddOfficePdfPageBreakCommand.cs:19 Edit on GitHub

Adds a page break to a PDF document.

Remarks

Adds a page break to a PDF document.

Examples

Authored help example

Start an appendix on a new page.

PS>


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.

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

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

Parameter set: Context

Parameters

PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.

Outputs

OfficeIMO.Pdf.PdfDocument

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

Parameter set: Document

Parameters

Document PdfDocument requiredposition: namedpipeline: True (ByValue): PDF document to update outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.

Outputs

OfficeIMO.Pdf.PdfDocument