Cmdlet

Set-OfficeExcelSmartHyperlink

Aliases: ExcelHyperlinkSmart

Module: PSWriteOffice
Aliases: ExcelHyperlinkSmart
Inputs: OfficeIMO.Excel.ExcelDocument
Source: SetOfficeExcelSmartHyperlinkCommand.cs:16 Edit on GitHub

Sets an external hyperlink using a smart display strategy.

Syntax

Set-OfficeExcelSmartHyperlink
[-Address <String>]
[-Column <Int32>]
[-NoStyle]
[-PassThru]
[-Row <Int32>]
[-Title <String>]
[-Url] <String>
[<CommonParameters>]

Parameter set: Context

Set-OfficeExcelSmartHyperlink
[-Address <String>]
[-Column <Int32>]
-Document <ExcelDocument>
[-NoStyle]
[-PassThru]
[-Row <Int32>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[-Title <String>]
[-Url] <String>
[<CommonParameters>]

Parameter set: Document

Examples

Link to an RFC with generated display text.

ExcelSheet 'Data' { Set-OfficeExcelSmartHyperlink -Address 'A2' -Url 'https://datatracker.ietf.org/doc/html/rfc7208' }

Creates a hyperlink that displays RFC 7208 instead of the full URL.

Parameters

-Address String optional: A1-style cell address (e.g., A1, C5).
-Column Int32 optional: 1-based column index.
-NoStyle SwitchParameter optional: Skip hyperlink styling (blue + underline).
-PassThru SwitchParameter optional: Emit the worksheet after setting the link.
-Row Int32 optional: 1-based row index.
-Title String optional: Optional preferred display text.
-Url String requiredposition: 0: External URL to link to.
-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.