Cmdlet

Add-OfficePdfSpacer

Aliases: PdfSpace, PdfSpacer

Module PSWriteOffice

Aliases

PdfSpace PdfSpacer

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

AddOfficePdfSpacerCommand.cs:22 Edit on GitHub

Adds invisible vertical spacing to a generated PDF document.

Syntax

Add-OfficePdfSpacer [-Height] <Double> [-PassThru] [<CommonParameters>]

Parameter set: Context

Add-OfficePdfSpacer -Document <PdfDocument> [-Height] <Double> [-PassThru] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Add vertical rhythm between sections.

New-OfficePdf -Path .\Examples\Documents\PdfSpacer.pdf {
    Add-OfficePdfHeading -Text 'Summary'
    Add-OfficePdfParagraph -Text 'First block.'
    Add-OfficePdfSpacer -Height 18
    Add-OfficePdfParagraph -Text 'Second block after additional spacing.'
}

Adds whitespace without adding visible content.

Parameters

-Height Double requiredposition: 0: Vertical space height in PDF points.
-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.