Cmdlet

Set-OfficeExcelInternalLinks

Aliases: ExcelInternalLinks

Module: PSWriteOffice
Aliases: ExcelInternalLinks
Inputs: OfficeIMO.Excel.ExcelDocument
Outputs: OfficeIMO.Excel.ExcelSheet
Source: SetOfficeExcelInternalLinksCommand.cs:17 Edit on GitHub

Converts cells in a range into internal workbook links.

Syntax

Set-OfficeExcelInternalLinks
[-DestinationSheetScript <ScriptBlock>]
[-DisplayScript <ScriptBlock>]
[-NoStyle]
[-PassThru]
[-Range] <String>
[-TargetAddress <String>]
[<CommonParameters>]

Parameter set: Context

Set-OfficeExcelInternalLinks
[-DestinationSheetScript <ScriptBlock>]
[-DisplayScript <ScriptBlock>]
-Document <ExcelDocument>
[-NoStyle]
[-PassThru]
[-Range] <String>
[-Sheet <String>]
[-SheetIndex <Int32>]
[-TargetAddress <String>]
[<CommonParameters>]

Parameter set: Document

Examples

Link a summary range to same-named sheets.

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 ScriptBlock optional: Optional mapping from cell text to destination sheet name.
-DisplayScript ScriptBlock optional: Optional mapping from cell text to display text.
-NoStyle SwitchParameter optional: Skip hyperlink styling (blue + underline).
-PassThru SwitchParameter optional: Emit the worksheet after creating links.
-Range String requiredposition: 0: A1 range containing values to convert into internal links.
-TargetAddress String optional: Destination cell on the target sheet.
-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.