Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

Stars 159

Forks 14

PowerShell Gallery downloads 158,661

Release v3.0.5

Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Get-OfficeWordHyperlink

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument OfficeIMO.Word.WordParagraph OfficeIMO.Word.WordSection

Outputs

OfficeIMO.Word.WordHyperLink

Source

Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordHyperlinkCommand.cs:22 Edit on GitHub

Gets hyperlinks from a Word document.

Remarks

Gets hyperlinks from a Word document.

Examples

Authored help example

Audit external hyperlinks in a report.

PS>


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

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-OfficeWordHyperlink [-Anchor <String[]>] -Path <String> [-Text <String[]>] [-Url <String[]>] [<CommonParameters>]

Parameter set: Path

Parameters

Anchor String[] optionalposition: namedpipeline: Falsealiases: Bookmark: Filter by bookmark anchor (wildcards supported).
Path String requiredposition: 0pipeline: Falsealiases: FilePath, InputPath: Path to the document.
Text String[] optionalposition: namedpipeline: False: Filter by hyperlink text (wildcards supported).
Url String[] optionalposition: namedpipeline: Falsealiases: Uri: Filter by external URL (wildcards supported).

Outputs

OfficeIMO.Word.WordHyperLink

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

Parameter set: Document

Parameters

Anchor String[] optionalposition: namedpipeline: Falsealiases: Bookmark: Filter by bookmark anchor (wildcards supported).
Document WordDocument requiredposition: namedpipeline: True (ByValue): Document to inspect.
Text String[] optionalposition: namedpipeline: False: Filter by hyperlink text (wildcards supported).
Url String[] optionalposition: namedpipeline: Falsealiases: Uri: Filter by external URL (wildcards supported).

Outputs

OfficeIMO.Word.WordHyperLink

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

Parameter set: Section

Parameters

Anchor String[] optionalposition: namedpipeline: Falsealiases: Bookmark: Filter by bookmark anchor (wildcards supported).
Section WordSection requiredposition: namedpipeline: True (ByValue): Section to inspect.
Text String[] optionalposition: namedpipeline: False: Filter by hyperlink text (wildcards supported).
Url String[] optionalposition: namedpipeline: Falsealiases: Uri: Filter by external URL (wildcards supported).

Outputs

OfficeIMO.Word.WordHyperLink

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

Parameter set: Paragraph

Parameters

Anchor String[] optionalposition: namedpipeline: Falsealiases: Bookmark: Filter by bookmark anchor (wildcards supported).
Paragraph WordParagraph requiredposition: namedpipeline: True (ByValue): Paragraph to inspect.
Text String[] optionalposition: namedpipeline: False: Filter by hyperlink text (wildcards supported).
Url String[] optionalposition: namedpipeline: Falsealiases: Uri: Filter by external URL (wildcards supported).

Outputs

OfficeIMO.Word.WordHyperLink