Add-OfficePdfPanel

Aliases: PdfPanel

Namespace PSWriteOffice

Aliases

PdfPanel

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

Sources/PSWriteOffice/Cmdlets/Pdf/AddOfficePdfPanelCommand.cs:17 Edit on GitHub

Adds a visually separated panel paragraph to a PDF document.

Remarks

Adds a visually separated panel paragraph to a PDF document.

Examples

Authored help example

Add a callout panel to a report.

PS>


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.

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-OfficePdfPanel [-Align <Left|Center|Right|Justify>] [-PassThru] -Text <String> [<CommonParameters>]

Parameter set: Context

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Panel alignment.; Possible values: Left, Center, Right, Justify
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Text String requiredposition: 0pipeline: False: Panel text.

Outputs

OfficeIMO.Pdf.PdfDocument

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

Parameter set: Document

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Panel alignment.; Possible values: Left, Center, Right, Justify
Document PdfDocument requiredposition: namedpipeline: True (ByValue): PDF document to update outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Text String requiredposition: 0pipeline: False: Panel text.

Outputs

OfficeIMO.Pdf.PdfDocument