PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

Stars 144

Forks 12

Open issues 16

PowerShell Gallery downloads 150,904

Release v0.2.0

Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Get-OfficeWordHyperlink

Namespace PSWriteOffice

Inputs

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

Outputs

OfficeIMO.Word.WordHyperLink

Source

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

Gets hyperlinks from a Word document.

Remarks

Gets hyperlinks from a Word document.

Examples

Authored help example

List hyperlinks from a document.

PS>


Get-OfficeWordHyperlink -Path .\Report.docx

Returns hyperlinks found in the document.

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[]>] -InputPath <String> [-Text <String[]>] [-Url <String[]>] [<CommonParameters>]

Parameter set: Path

Parameters

Anchor String[] optionalposition: namedpipeline: Falsealiases: Bookmark: Filter by bookmark anchor (wildcards supported).
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: 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