Create a hyperlink with the specified Uri, and optionally using different text, background and foreground colors
New-Hyperlink [-Uri] <String> [[-Object] <Object>] [-Separator <Object>] [-BackgroundColor <RgbColor>] [-ForegroundColor <RgbColor>] [-LeaveColor] [-IgnoreEntities] [-Passthru]
Create a hyperlink with the specified Uri, using ANSI Virtual Terminal escape sequences. As with New-Text, there's full support for setting background and foreground colors, and rendering HTML-style entities.
With -Passthru, returns the Text object, but normally outputs the text string with the Uri hyperlink embedded.
PS C:\> New-Hyperlink https://PoshCode.org -ForegroundColor Green
`e[92m`e]8;;https://PoshCode.org`ahttps://PoshCode.org`e]8;;`a`e[39m
Generates a hyperlink to https://PoshCode.org with the text https://PoshCode.org and a green foreground color.
This use, without text (the -Object parameter) and with a highlight color, is the most compatible use, because if the terminal doesn't support links, at least the URL will be visible, and highlighted in color
PS C:\> "Please visit $(New-Hyperlink https://PoshCode.org PoshCode)"
Please visit `e]8;;https://PoshCode.org`aPoshCode`e]8;;`a
Generates a hyperlink to https://PoshCode.org with the text "PoshCode". You should be careful of this syntax, where you don't include the full URL in the display, because terminals which don't support hyperlinks (like the default Windows console) will not display the Url, nor any indication that it should be a link.
Specifies the Uri to link to.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseThe background color. You may specify it as CSS hex "#RRGGBB" (or just "RRGGBB") or as an XTerm index "xt123" (or just "123") or as a ConsoleColor like "Red" or "DarkRed"...
Type: RgbColor
Parameter Sets: (All)
Aliases: Bg
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe foreground color. You may specify it as CSS hex "#RRGGBB" (or just "RRGGBB") or as an XTerm index "xt123" (or just "123") or as a ConsoleColor like "Red" or "DarkRed"...
Type: RgbColor
Parameter Sets: (All)
Aliases: Fg
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf set, don't render the HTML Entities to characters (i.e. leave "♥" as "♥" instead of as "♥")
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf set, don't clear the colors at the end of the output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies objects to display as the text of the link.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue, FromRemainingArguments)
Accept wildcard characters: FalseSpecifies a separator string to output between objects displayed on the console.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf set, outputs a Text object, rather than simple string
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False