API Reference
Cmdlet
Add-OfficeWordHyperlink
Adds a hyperlink to the current Word paragraph.
Remarks
Adds a hyperlink to the current Word paragraph.
Examples
Add an external hyperlink.
PS>
Add-OfficeWordParagraph { Add-OfficeWordHyperlink -Text 'Example' -Url 'https://example.org' -Styled }
Creates a styled external hyperlink in the active paragraph.
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
Add-OfficeWordHyperlink [-NoHistory] [-PassThru] [-Styled] -Text <String> [-Tooltip <String>] -Url <String> [<CommonParameters>]Parameter set:
ContextUrlParameters
- NoHistory SwitchParameter
- Do not mark the hyperlink in navigation history.
- PassThru SwitchParameter
- Emit the created hyperlink.
- Styled SwitchParameter
- Apply the built-in hyperlink style.
- Text String
- Displayed hyperlink text.
- Tooltip String
- Optional hyperlink tooltip.
- Url String
- External hyperlink URL.
Outputs
OfficeIMO.Word.WordHyperLink
Add-OfficeWordHyperlink [-NoHistory] -Paragraph <WordParagraph> [-PassThru] [-Styled] -Text <String> [-Tooltip <String>] -Url <String> [<CommonParameters>]Parameter set:
ParagraphUrlParameters
- NoHistory SwitchParameter
- Do not mark the hyperlink in navigation history.
- Paragraph WordParagraph
- Paragraph to update outside the DSL context.
- PassThru SwitchParameter
- Emit the created hyperlink.
- Styled SwitchParameter
- Apply the built-in hyperlink style.
- Text String
- Displayed hyperlink text.
- Tooltip String
- Optional hyperlink tooltip.
- Url String
- External hyperlink URL.
Outputs
OfficeIMO.Word.WordHyperLink
Add-OfficeWordHyperlink -Anchor <String> [-NoHistory] -Paragraph <WordParagraph> [-PassThru] [-Styled] -Text <String> [-Tooltip <String>] [<CommonParameters>]Parameter set:
ParagraphAnchorParameters
- Anchor String
- Bookmark anchor target within the document.
- NoHistory SwitchParameter
- Do not mark the hyperlink in navigation history.
- Paragraph WordParagraph
- Paragraph to update outside the DSL context.
- PassThru SwitchParameter
- Emit the created hyperlink.
- Styled SwitchParameter
- Apply the built-in hyperlink style.
- Text String
- Displayed hyperlink text.
- Tooltip String
- Optional hyperlink tooltip.
Outputs
OfficeIMO.Word.WordHyperLink
Add-OfficeWordHyperlink -Anchor <String> [-NoHistory] [-PassThru] [-Styled] -Text <String> [-Tooltip <String>] [<CommonParameters>]Parameter set:
ContextAnchorParameters
- Anchor String
- Bookmark anchor target within the document.
- NoHistory SwitchParameter
- Do not mark the hyperlink in navigation history.
- PassThru SwitchParameter
- Emit the created hyperlink.
- Styled SwitchParameter
- Apply the built-in hyperlink style.
- Text String
- Displayed hyperlink text.
- Tooltip String
- Optional hyperlink tooltip.
Outputs
OfficeIMO.Word.WordHyperLink