Skip to content

Get-OfficeWordHyperlink.md

Latest commit

 

History

History
174 lines (136 loc) · 3.35 KB

Get-OfficeWordHyperlink.md

File metadata and controls

174 lines (136 loc) · 3.35 KB
external help file PSWriteOffice-help.xml
Module Name PSWriteOffice
online version https://github.com/EvotecIT/PSWriteOffice
schema 2.0.0

Get-OfficeWordHyperlink

SYNOPSIS

Gets hyperlinks from a Word document.

SYNTAX

Path (Default)

Get-OfficeWordHyperlink [-InputPath] <string> [-Text <string[]>] [-Url <string[]>] [-Anchor <string[]>] [<CommonParameters>]

Document

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

Section

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

Paragraph

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

DESCRIPTION

Gets hyperlinks from a Word document.

EXAMPLES

EXAMPLE 1

PS>Get-OfficeWordHyperlink -Path .\Report.docx

Returns hyperlinks found in the document.

PARAMETERS

-Anchor

Filter by bookmark anchor (wildcards supported).

Type: String[]
Parameter Sets: Path, Document, Section, Paragraph
Aliases: Bookmark
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Document

Document to inspect.

Type: WordDocument
Parameter Sets: Document
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-InputPath

Path to the document.

Type: String
Parameter Sets: Path
Aliases: FilePath, Path
Possible values: 

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Paragraph

Paragraph to inspect.

Type: WordParagraph
Parameter Sets: Paragraph
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-Section

Section to inspect.

Type: WordSection
Parameter Sets: Section
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-Text

Filter by hyperlink text (wildcards supported).

Type: String[]
Parameter Sets: Path, Document, Section, Paragraph
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Url

Filter by external URL (wildcards supported).

Type: String[]
Parameter Sets: Path, Document, Section, Paragraph
Aliases: Uri
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

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

OUTPUTS

  • OfficeIMO.Word.WordHyperLink

RELATED LINKS

  • None