Cmdlet

Add-OfficeWordHyperlink

Aliases: WordHyperlink

Module: PSWriteOffice
Aliases: WordHyperlink
Inputs: OfficeIMO.Word.WordParagraph
Outputs: OfficeIMO.Word.WordHyperLink
Source: AddOfficeWordHyperlinkCommand.cs:18 Edit on GitHub

Adds a hyperlink to the current Word paragraph.

Syntax

Add-OfficeWordHyperlink
[-NoHistory]
[-PassThru]
[-Styled]
[-Text] <String>
[-Tooltip <String>]
-Url <String>
[<CommonParameters>]

Parameter set: ContextUrl

Add-OfficeWordHyperlink
[-NoHistory]
-Paragraph <WordParagraph>
[-PassThru]
[-Styled]
[-Text] <String>
[-Tooltip <String>]
-Url <String>
[<CommonParameters>]

Parameter set: ParagraphUrl

Add-OfficeWordHyperlink
-Anchor <String>
[-NoHistory]
-Paragraph <WordParagraph>
[-PassThru]
[-Styled]
[-Text] <String>
[-Tooltip <String>]
[<CommonParameters>]

Parameter set: ParagraphAnchor

Add-OfficeWordHyperlink
-Anchor <String>
[-NoHistory]
[-PassThru]
[-Styled]
[-Text] <String>
[-Tooltip <String>]
[<CommonParameters>]

Parameter set: ContextAnchor

Examples

Add an external hyperlink.

Add-OfficeWordParagraph { Add-OfficeWordHyperlink -Text 'Example' -Url 'https://example.org' -Styled }

Creates a styled external hyperlink in the active paragraph.

Parameters

-NoHistory SwitchParameter optional: Do not mark the hyperlink in navigation history.
-PassThru SwitchParameter optional: Emit the created hyperlink.
-Styled SwitchParameter optional: Apply the built-in hyperlink style.
-Text String requiredposition: 0: Displayed hyperlink text.
-Tooltip String optional: Optional hyperlink tooltip.
-Url String requiredaliases: Urisets: ContextUrl, ParagraphUrl: External hyperlink URL.
-Paragraph WordParagraph requiredpipeline: True (ByValue)sets: ParagraphUrl, ParagraphAnchor: Paragraph to update outside the DSL context.
-Anchor String requiredaliases: Bookmarksets: ParagraphAnchor, ContextAnchor: Bookmark anchor target within 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.