Cmdlet

Add-OfficePdfPanel

Aliases: PdfPanel

Module PSWriteOffice

Aliases

PdfPanel

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

AddOfficePdfPanelCommand.cs:20 Edit on GitHub

Adds a visually separated panel paragraph to a PDF document.

Syntax

Add-OfficePdfPanel [-Align <Left|Center|Right|Justify>] [-PassThru] [-Text] <String> [<CommonParameters>]

Parameter set: Context

Add-OfficePdfPanel [-Align <Left|Center|Right|Justify>] -Document <PdfDocument> [-PassThru] [-Text] <String> [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Add a callout panel to a report.

New-OfficePdf -Path .\Examples\Documents\PdfPanel.pdf {
    Add-OfficePdfHeading -Text 'Executive summary'
    Add-OfficePdfPanel -Text 'No critical incidents were detected in the current reporting window.' -Align Center
}

Adds a highlighted panel paragraph to the generated PDF.

Parameters

-Align PdfAlign optional: Panel alignment.; Possible values: Left, Center, Right, Justify
-PassThru SwitchParameter optional: Emit the updated document.
-Text String requiredposition: 0: Panel text.
-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.