Add-OfficePdfSpacer

Aliases: PdfSpace, PdfSpacer

Namespace PSWriteOffice

Aliases

PdfSpace PdfSpacer

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

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

Adds invisible vertical spacing to a generated PDF document.

Remarks

Adds invisible vertical spacing to a generated PDF document.

Examples

Authored help example

Add vertical rhythm between sections.

PS>


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.

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-OfficePdfSpacer -Height <Double> [-PassThru] [<CommonParameters>]

Parameter set: Context

Parameters

Height Double requiredposition: 0pipeline: False: Vertical space height in PDF points.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.

Outputs

OfficeIMO.Pdf.PdfDocument

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

Parameter set: Document

Parameters

Document PdfDocument requiredposition: namedpipeline: True (ByValue): PDF document to update outside the DSL context.
Height Double requiredposition: 0pipeline: False: Vertical space height in PDF points.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.

Outputs

OfficeIMO.Pdf.PdfDocument