Cmdlet

Set-OfficeExcelUrlLinks

Aliases: ExcelUrlLinks

Module: PSWriteOffice
Aliases: ExcelUrlLinks
Inputs: OfficeIMO.Excel.ExcelDocument
Outputs: OfficeIMO.Excel.ExcelSheet
Source: SetOfficeExcelUrlLinksCommand.cs:17 Edit on GitHub

Converts cells in a range into external URL hyperlinks.

Syntax

Set-OfficeExcelUrlLinks
[-NoStyle]
[-PassThru]
[-Range] <String>
[-TitleScript <ScriptBlock>]
-UrlScript <ScriptBlock>
[<CommonParameters>]

Parameter set: Context

Set-OfficeExcelUrlLinks
-Document <ExcelDocument>
[-NoStyle]
[-PassThru]
[-Range] <String>
[-Sheet <String>]
[-SheetIndex <Int32>]
[-TitleScript <ScriptBlock>]
-UrlScript <ScriptBlock>
[<CommonParameters>]

Parameter set: Document

Examples

Link a summary range to RFC pages.

ExcelSheet 'Summary' { Set-OfficeExcelUrlLinks -Range 'D2:D10' -UrlScript { param($text) "https://datatracker.ietf.org/doc/html/$text" } }

Turns each non-empty cell in D2:D10 into an external hyperlink.

Parameters

-NoStyle SwitchParameter optional: Skip hyperlink styling (blue + underline).
-PassThru SwitchParameter optional: Emit the worksheet after creating links.
-Range String requiredposition: 0: A1 range containing values to convert into external links.
-TitleScript ScriptBlock optional: Optional mapping from cell text to display text.
-UrlScript ScriptBlock required: Maps the cell text to a URL.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook to operate on outside the DSL context.
-Sheet String optionalsets: Document: Worksheet name when using Document.
-SheetIndex Int32 optionalsets: Document: Worksheet index (0-based) when using 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.