Cmdlet
Set-OfficePdfFooter
Sets a simple or fully composed running PDF footer.
Syntax
Examples
Add page numbers to a generated PDF.
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.
Compose a styled footer with page tokens.
New-OfficePdf -Path .\Examples\Documents\RichFooter.pdf {
Set-OfficePdfFooter -Compose {
param($footer)
$label = New-OfficeTextRun -Text 'Confidential - page ' -Bold | ConvertTo-OfficePdfTextRun
$pageStyle = New-OfficeTextRun -Italic | ConvertTo-OfficePdfTextRun
$null = $footer.AlignRight().Text({
param($text)
$null = $text.Run($label).CurrentPage($pageStyle).Text(' of ').TotalPages($pageStyle)
})
}
Add-OfficePdfParagraph -Text 'Generated report body.'
}Styled page tokens remain live until the document is rendered.
Parameters
- -Align PdfAlign
- Footer alignment.
- Possible values:
Left,Center,Right,Justify - -Compose ScriptBlock
- Advanced footer composer. The script receives a PdfFooterBuilder and can configure default, first-page, and even-page text, zones, images, shapes, rich text, and page tokens.
- -FontSize Double
- Footer font size in PDF points.
- -PassThru SwitchParameter
- Emit the updated document.
- -Text String
- Footer text. Supports {page} and {pages}.
- -Document PdfDocument
- Compatibility parameter. Page composition is supported only inside New-OfficePdf.
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.