Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

Get-OfficeWordFootnote

Aliases: WordFootnotes
Module PSWriteOffice
Aliases
WordFootnotes
Inputs
OfficeIMO.Word.WordDocument OfficeIMO.Word.WordSection
Outputs
PSWriteOffice.Services.Word.WordNoteInfo

Gets footnotes from a Word document or section.

Syntax

Get-OfficeWordFootnote [-Path] <String> [<CommonParameters>]
#
Parameter set: Path
Get-OfficeWordFootnote -Document <WordDocument> [<CommonParameters>]
#
Parameter set: Document
Get-OfficeWordFootnote -Section <WordSection> [<CommonParameters>]
#
Parameter set: Section

Examples

Authored help example

Export footnotes for review.

$footnotes = Get-OfficeWordFootnote -Path .\PolicyReport.docx
$footnotes |
    Select-Object -Property Kind, ReferenceId, ParentText, Text |
    Export-Csv -Path .\Footnotes.csv -NoTypeInformation

Reads footnotes from the document and exports the PowerShell-friendly note snapshot.

Parameters

-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path
Path to the document.
-Document WordDocument requiredpipeline: True (ByValue)sets: Document
Document to inspect.
-Section WordSection requiredpipeline: True (ByValue)sets: Section
Section to inspect.

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.

Outputs

PSWriteOffice.Services.Word.WordNoteInfo: Describes a Word footnote or endnote in a document-safe snapshot.