Set-OfficePdfFooter

Aliases: PdfFooter

Namespace PSWriteOffice

Aliases

PdfFooter

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

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

Sets running PDF footer text.

Remarks

Sets running PDF footer text.

Examples

Authored help example

Add page numbers to a generated PDF.

PS>


New-OfficePdf -Path .\Examples\Documents\PdfFooter.pdf {
                Set-OfficePdfFooter -Text 'Page {page} of {pages}' -Align Center -FontSize 8
                Add-OfficePdfHeading -Text 'Report with footer'
                Add-OfficePdfPageBreak
                Add-OfficePdfParagraph -Text 'The footer includes generated page numbers.'
            }

Uses page placeholders in a running footer.

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

Set-OfficePdfFooter [-Align <Left|Center|Right|Justify>] [-FontSize <Nullable`1>] [-PassThru] [-Text <String>] [<CommonParameters>]

Parameter set: Context

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Footer alignment.; Possible values: Left, Center, Right, Justify
FontSize Nullable`1 optionalposition: namedpipeline: False: Footer font size in PDF points.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Text String optionalposition: 0pipeline: False: Footer text. Supports {page} and {pages}.

Outputs

OfficeIMO.Pdf.PdfDocument

Set-OfficePdfFooter [-Align <Left|Center|Right|Justify>] -Document <PdfDocument> [-FontSize <Nullable`1>] [-PassThru] [-Text <String>] [<CommonParameters>]

Parameter set: Document

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Footer alignment.; Possible values: Left, Center, Right, Justify
Document PdfDocument requiredposition: namedpipeline: True (ByValue): PDF document to update outside the DSL context.
FontSize Nullable`1 optionalposition: namedpipeline: False: Footer font size in PDF points.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Text String optionalposition: 0pipeline: False: Footer text. Supports {page} and {pages}.

Outputs

OfficeIMO.Pdf.PdfDocument