Skip to content

Set-OfficeExcelSmartHyperlink.md

Latest commit

 

History

History
210 lines (165 loc) · 3.96 KB

Set-OfficeExcelSmartHyperlink.md

File metadata and controls

210 lines (165 loc) · 3.96 KB
external help file PSWriteOffice-help.xml
Module Name PSWriteOffice
online version https://github.com/EvotecIT/PSWriteOffice
schema 2.0.0

Set-OfficeExcelSmartHyperlink

SYNOPSIS

Sets an external hyperlink using a smart display strategy.

SYNTAX

Context (Default)

Set-OfficeExcelSmartHyperlink [-Url] <string> [-Row <int>] [-Column <int>] [-Address <string>] [-Title <string>] [-NoStyle] [-PassThru] [<CommonParameters>]

Document

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

DESCRIPTION

Sets an external hyperlink using a smart display strategy.

EXAMPLES

EXAMPLE 1

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

A1-style cell address (e.g., A1, C5).

Type: String
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Column

1-based column index.

Type: Nullable`1
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Document

Workbook to operate on outside the DSL context.

Type: ExcelDocument
Parameter Sets: Document
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-NoStyle

Skip hyperlink styling (blue + underline).

Type: SwitchParameter
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PassThru

Emit the worksheet after setting the link.

Type: SwitchParameter
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Row

1-based row index.

Type: Nullable`1
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Sheet

Worksheet name when using Document.

Type: String
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SheetIndex

Worksheet index (0-based) when using Document.

Type: Nullable`1
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Title

Optional preferred display text.

Type: String
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Url

External URL to link to.

Type: String
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • OfficeIMO.Excel.ExcelDocument

OUTPUTS

  • System.Object

RELATED LINKS

  • None