Cmdlet

Set-OfficeExcelInternalLinksByHeader

Aliases: ExcelInternalLinksByHeader

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

Converts cells under a header into internal workbook links.

Syntax

Set-OfficeExcelInternalLinksByHeader
[-DestinationSheetScript <ScriptBlock>]
[-DisplayScript <ScriptBlock>]
[-Header] <String>
[-NoStyle]
[-PassThru]
[-TargetAddress <String>]
[<CommonParameters>]

Parameter set: ContextUsedRange

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

Parameter set: DocumentUsedRange

Set-OfficeExcelInternalLinksByHeader
[-DestinationSheetScript <ScriptBlock>]
[-DisplayScript <ScriptBlock>]
-Document <ExcelDocument>
[-Header] <String>
[-NoStyle]
[-PassThru]
[-Sheet <String>]
[-SheetIndex <Int32>]
-TableName <String>
[-TargetAddress <String>]
[<CommonParameters>]

Parameter set: DocumentTable

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

Parameter set: DocumentRange

Set-OfficeExcelInternalLinksByHeader
[-DestinationSheetScript <ScriptBlock>]
[-DisplayScript <ScriptBlock>]
[-Header] <String>
[-NoStyle]
[-PassThru]
-TableName <String>
[-TargetAddress <String>]
[<CommonParameters>]

Parameter set: ContextTable

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

Parameter set: ContextRange

Examples

Link the Sheet column in the used range.

ExcelSheet 'Summary' { Set-OfficeExcelInternalLinksByHeader -Header 'Sheet' }

Uses the used range header row to find the Sheet column and converts its values into internal links.

Parameters

-DestinationSheetScript ScriptBlock optional: Optional mapping from cell text to destination sheet name.
-DisplayScript ScriptBlock optional: Optional mapping from cell text to display text.
-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.
-TargetAddress String optional: Destination cell on the target sheet.
-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.