Set-OfficeExcelUrlLinks

Namespace PSWriteOffice

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

OfficeIMO.Excel.ExcelSheet

Converts cells in a range into external URL hyperlinks.

Remarks

Converts cells in a range into external URL hyperlinks.

Examples

Link a summary range to RFC pages.


PS>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.

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

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

Parameter set: Context

Parameters

NoStyle SwitchParameter optionalposition: namedpipeline: False: Skip hyperlink styling (blue + underline).
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the worksheet after creating links.
Range String requiredposition: 0pipeline: False: A1 range containing values to convert into external links.
TitleScript ScriptBlock optionalposition: namedpipeline: False: Optional mapping from cell text to display text.
UrlScript ScriptBlock requiredposition: namedpipeline: False: Maps the cell text to a URL.

Outputs

OfficeIMO.Excel.ExcelSheet

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

Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to operate on outside the DSL context.
NoStyle SwitchParameter optionalposition: namedpipeline: False: Skip hyperlink styling (blue + underline).
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the worksheet after creating links.
Range String requiredposition: 0pipeline: False: A1 range containing values to convert into external links.
Sheet String optionalposition: namedpipeline: False: Worksheet name when using Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) when using Document.
TitleScript ScriptBlock optionalposition: namedpipeline: False: Optional mapping from cell text to display text.
UrlScript ScriptBlock requiredposition: namedpipeline: False: Maps the cell text to a URL.

Outputs

OfficeIMO.Excel.ExcelSheet