Cmdlet

Add-OfficeWordPageNumber

Aliases: WordPageNumber

Module: PSWriteOffice
Aliases: WordPageNumber
Inputs: None
Source: AddOfficeWordPageNumberCommand.cs:18 Edit on GitHub

Adds a PAGE field to the current header/footer.

Syntax

Add-OfficeWordPageNumber
[-Format <WordFieldFormat>]
[-IncludeTotal]
[-PassThru]
[-Separator <String>]
[<CommonParameters>]

Parameter set: Default

Description

Typically used inside WordFooter to render “Page X of Y”.

Examples

Footer page numbering.

WordFooter { Add-OfficeWordPageNumber -IncludeTotal }

Outputs “Page # of #” in the footer.

Parameters

-Format WordFieldFormat optional: Optional number format.; Possible values: Lower, Upper, FirstCap, Caps, MergeFormat, UpperRoman, LowerRoman, Arabic, LowerLetter, UpperLetter, Ordinal, OrdText, CardText, DollarText, Hex, CharFormat
-IncludeTotal SwitchParameter optional: Include “of N” when true.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Separator String optional: Separator when totals are included.

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.