Cmdlet

Get-OfficeWordHyperlink

Module: PSWriteOffice
Inputs: OfficeIMO.Word.WordDocument OfficeIMO.Word.WordParagraph OfficeIMO.Word.WordSection System.String[]
Outputs: OfficeIMO.Word.WordHyperLink
Source: GetOfficeWordHyperlinkCommand.cs:10 Edit on GitHub

Gets hyperlinks, filtered by text, URL or bookmark anchor.

Syntax

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

Parameter set: Document

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

Parameter set: Path

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

Parameter set: LiteralPath

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

Example 1

Get-OfficeWordHyperlink -Anchor @('Value')

Example 2

Get-OfficeWordHyperlink -LiteralPath @('C:\Path')

Example 3

Get-OfficeWordHyperlink -Paragraph 'Value'

Parameters

-Anchor String[] optional: Anchor for this inspection.
-Document WordDocument optionalpipeline: True (ByValue)sets: Document: Document for this inspection.
-Text String[] optional: Text for this inspection.
-Url String[] optional: Url for this inspection.
-Path String[] requiredposition: 0pipeline: True (ByValue)sets: Path: Path for this inspection.
-LiteralPath String[] requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: LiteralPath for this inspection.
-Section WordSection requiredpipeline: True (ByValue)sets: Section: Section for this inspection.
-Paragraph WordParagraph requiredpipeline: True (ByValue)sets: Paragraph: Paragraph for this inspection.

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.