Set-OfficeExcelInternalLinks.md

external help file	PSWriteOffice-help.xml
Module Name	PSWriteOffice
online version	https://github.com/EvotecIT/PSWriteOffice
schema	2.0.0

Set-OfficeExcelInternalLinks

SYNOPSIS

Converts cells in a range into internal workbook links.

SYNTAX

Context (Default)

Set-OfficeExcelInternalLinks [-Range] <string> [-DestinationSheetScript <scriptblock>] [-DisplayScript <scriptblock>] [-TargetAddress <string>] [-NoStyle] [-PassThru] [<CommonParameters>]

Document

Set-OfficeExcelInternalLinks [-Range] <string> -Document <ExcelDocument> [-Sheet <string>] [-SheetIndex <int>] [-DestinationSheetScript <scriptblock>] [-DisplayScript <scriptblock>] [-TargetAddress <string>] [-NoStyle] [-PassThru] [<CommonParameters>]

DESCRIPTION

Converts cells in a range into internal workbook links.

EXAMPLES

EXAMPLE 1

PS>ExcelSheet 'Summary' { Set-OfficeExcelInternalLinks -Range 'A2:A10' }

Turns each non-empty cell in A2:A10 into an internal link to the sheet with the same name.

PARAMETERS

-DestinationSheetScript

Optional mapping from cell text to destination sheet name.

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

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

-DisplayScript

Optional mapping from cell text to display text.

Type: ScriptBlock
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 creating links.

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

-Range

A1 range containing values to convert into internal links.

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

-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

-TargetAddress

Destination cell on the target sheet.

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

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

• OfficeIMO.Excel.ExcelSheet

RELATED LINKS

• None