Cmdlet

Set-OfficeExcelUrlLinksByHeader

Aliases: ExcelUrlLinksByHeader

Module: PSWriteOffice
Aliases: ExcelUrlLinksByHeader
Inputs: OfficeIMO.Excel.ExcelDocument
Outputs: OfficeIMO.Excel.ExcelSheet
Source: SetOfficeExcelUrlLinksByHeaderCommand.cs:18 Edit on GitHub

Converts cells under a header into external URL hyperlinks.

Syntax

Set-OfficeExcelUrlLinksByHeader
[-Header] <String>
[-NoStyle]
[-PassThru]
[-TitleScript <ScriptBlock>]
-UrlScript <ScriptBlock>
[<CommonParameters>]

Parameter set: ContextUsedRange

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

Parameter set: DocumentUsedRange

Set-OfficeExcelUrlLinksByHeader
-Document <ExcelDocument>
[-Header] <String>
[-NoStyle]
[-PassThru]
[-Sheet <String>]
[-SheetIndex <Int32>]
-TableName <String>
[-TitleScript <ScriptBlock>]
-UrlScript <ScriptBlock>
[<CommonParameters>]

Parameter set: DocumentTable

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

Parameter set: DocumentRange

Set-OfficeExcelUrlLinksByHeader
[-Header] <String>
[-NoStyle]
[-PassThru]
-TableName <String>
[-TitleScript <ScriptBlock>]
-UrlScript <ScriptBlock>
[<CommonParameters>]

Parameter set: ContextTable

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

Parameter set: ContextRange

Examples

Link the RFC column in a table.

ExcelSheet 'Summary' { Set-OfficeExcelUrlLinksByHeader -Header 'RFC' -TableName 'Links' -UrlScript { param($text) "https://datatracker.ietf.org/doc/html/$text" } }

Uses the RFC column values to create external hyperlinks.

Parameters

-Header String requiredposition: 0: Header text to locate.
-NoStyle SwitchParameter optional: Skip hyperlink styling (blue + underline).
-PassThru SwitchParameter optional: Emit the worksheet after creating 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: DocumentUsedRange, DocumentTable, DocumentRange: Workbook to operate on outside the DSL context.
-Sheet String optionalsets: DocumentUsedRange, DocumentTable, DocumentRange: Worksheet name when using Document.
-SheetIndex Int32 optionalsets: DocumentUsedRange, DocumentTable, DocumentRange: Worksheet index (0-based) when using Document.
-TableName String requiredsets: DocumentTable, ContextTable: Restrict linking to a named table.
-Range String requiredsets: DocumentRange, ContextRange: Restrict linking to a specific A1 range whose first row contains headers.

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.