Get-OfficeWordFootnote

Aliases: WordFootnotes

Namespace PSWriteOffice

Aliases

WordFootnotes

Inputs

OfficeIMO.Word.WordDocument OfficeIMO.Word.WordSection

Outputs

PSWriteOffice.Services.Word.WordNoteInfo

Source

Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordFootnoteCommand.cs:21 Edit on GitHub

Gets footnotes from a Word document or section.

Remarks

Gets footnotes from a Word document or section.

Examples

Authored help example

Export footnotes for review.

PS>


$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.

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

Get-OfficeWordFootnote -InputPath <String> [<CommonParameters>]

Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Path to the document.

Outputs

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

Get-OfficeWordFootnote -Document <WordDocument> [<CommonParameters>]

Parameter set: Document

Parameters

Document WordDocument requiredposition: namedpipeline: True (ByValue): Document to inspect.

Outputs

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

Get-OfficeWordFootnote -Section <WordSection> [<CommonParameters>]

Parameter set: Section

Parameters

Section WordSection requiredposition: namedpipeline: True (ByValue): Section to inspect.

Outputs

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