Cmdlet

Get-OfficeWordHyperlink

Module: PSWriteOffice
Inputs: OfficeIMO.Word.WordDocument OfficeIMO.Word.WordParagraph OfficeIMO.Word.WordSection
Outputs: OfficeIMO.Word.WordHyperLink
Source: GetOfficeWordHyperlinkCommand.cs:22 Edit on GitHub

Gets hyperlinks from a Word document.

Syntax

Get-OfficeWordHyperlink
[-Anchor <String[]>]
[-Path] <String>
[-Text <String[]>]
[-Url <String[]>]
[<CommonParameters>]

Parameter set: Path

Get-OfficeWordHyperlink
[-Anchor <String[]>]
-Document <WordDocument>
[-Text <String[]>]
[-Url <String[]>]
[<CommonParameters>]

Parameter set: Document

Get-OfficeWordHyperlink
[-Anchor <String[]>]
-Section <WordSection>
[-Text <String[]>]
[-Url <String[]>]
[<CommonParameters>]

Parameter set: Section

Get-OfficeWordHyperlink
[-Anchor <String[]>]
-Paragraph <WordParagraph>
[-Text <String[]>]
[-Url <String[]>]
[<CommonParameters>]

Parameter set: Paragraph

Examples

Audit external hyperlinks in a report.

$links = Get-OfficeWordHyperlink -Path .\Report.docx -Url 'https://*'
$links |
    Select-Object -Property Text, Uri |
    Export-Csv -Path .\ReportLinks.csv -NoTypeInformation

Filters external hyperlinks and exports them for link validation or review.

Parameters

-Anchor String[] optionalaliases: Bookmark: Filter by bookmark anchor (wildcards supported).
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Path to the document.
-Text String[] optional: Filter by hyperlink text (wildcards supported).
-Url String[] optionalaliases: Uri: Filter by external URL (wildcards supported).
-Document WordDocument requiredpipeline: True (ByValue)sets: Document: Document to inspect.
-Section WordSection requiredpipeline: True (ByValue)sets: Section: Section to inspect.
-Paragraph WordParagraph requiredpipeline: True (ByValue)sets: Paragraph: Paragraph 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.