API Reference
Command
Set-OfficeExcelInternalLinksByHeader
Converts cells under a header into internal workbook links.
Remarks
Converts cells under a header into internal workbook links.
Examples
Link the Sheet column in the used range.
PS>ExcelSheet 'Summary' { Set-OfficeExcelInternalLinksByHeader -Header 'Sheet' }
Uses the used range header row to find the Sheet column and converts its values into internal links.
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.
Syntax
Set-OfficeExcelInternalLinksByHeader [-DestinationSheetScript <ScriptBlock>] [-DisplayScript <ScriptBlock>] -Header <String> [-NoStyle] [-PassThru] [-TargetAddress <String>] [<CommonParameters>]Parameter set:
ContextUsedRangeParameters
- DestinationSheetScript ScriptBlock
- Optional mapping from cell text to destination sheet name.
- DisplayScript ScriptBlock
- Optional mapping from cell text to display text.
- Header String
- Header text to locate.
- NoStyle SwitchParameter
- Skip hyperlink styling (blue + underline).
- PassThru SwitchParameter
- Emit the worksheet after creating links.
- TargetAddress String
- Destination cell on the target sheet.
Outputs
OfficeIMO.Excel.ExcelSheet
Set-OfficeExcelInternalLinksByHeader [-DestinationSheetScript <ScriptBlock>] [-DisplayScript <ScriptBlock>] -Document <ExcelDocument> -Header <String> [-NoStyle] [-PassThru] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-TargetAddress <String>] [<CommonParameters>]Parameter set:
DocumentUsedRangeParameters
- DestinationSheetScript ScriptBlock
- Optional mapping from cell text to destination sheet name.
- DisplayScript ScriptBlock
- Optional mapping from cell text to display text.
- Document ExcelDocument
- Workbook to operate on outside the DSL context.
- Header String
- Header text to locate.
- NoStyle SwitchParameter
- Skip hyperlink styling (blue + underline).
- PassThru SwitchParameter
- Emit the worksheet after creating links.
- Sheet String
- Worksheet name when using Document.
- SheetIndex Nullable`1
- Worksheet index (0-based) when using Document.
- TargetAddress String
- Destination cell on the target sheet.
Outputs
OfficeIMO.Excel.ExcelSheet
Set-OfficeExcelInternalLinksByHeader [-DestinationSheetScript <ScriptBlock>] [-DisplayScript <ScriptBlock>] -Document <ExcelDocument> -Header <String> [-NoStyle] [-PassThru] [-Sheet <String>] [-SheetIndex <Nullable`1>] -TableName <String> [-TargetAddress <String>] [<CommonParameters>]Parameter set:
DocumentTableParameters
- DestinationSheetScript ScriptBlock
- Optional mapping from cell text to destination sheet name.
- DisplayScript ScriptBlock
- Optional mapping from cell text to display text.
- Document ExcelDocument
- Workbook to operate on outside the DSL context.
- Header String
- Header text to locate.
- NoStyle SwitchParameter
- Skip hyperlink styling (blue + underline).
- PassThru SwitchParameter
- Emit the worksheet after creating links.
- Sheet String
- Worksheet name when using Document.
- SheetIndex Nullable`1
- Worksheet index (0-based) when using Document.
- TableName String
- Restrict linking to a named table.
- TargetAddress String
- Destination cell on the target sheet.
Outputs
OfficeIMO.Excel.ExcelSheet
Set-OfficeExcelInternalLinksByHeader [-DestinationSheetScript <ScriptBlock>] [-DisplayScript <ScriptBlock>] -Document <ExcelDocument> -Header <String> [-NoStyle] [-PassThru] -Range <String> [-Sheet <String>] [-SheetIndex <Nullable`1>] [-TargetAddress <String>] [<CommonParameters>]Parameter set:
DocumentRangeParameters
- DestinationSheetScript ScriptBlock
- Optional mapping from cell text to destination sheet name.
- DisplayScript ScriptBlock
- Optional mapping from cell text to display text.
- Document ExcelDocument
- Workbook to operate on outside the DSL context.
- Header String
- Header text to locate.
- NoStyle SwitchParameter
- Skip hyperlink styling (blue + underline).
- PassThru SwitchParameter
- Emit the worksheet after creating links.
- Range String
- Restrict linking to a specific A1 range whose first row contains headers.
- Sheet String
- Worksheet name when using Document.
- SheetIndex Nullable`1
- Worksheet index (0-based) when using Document.
- TargetAddress String
- Destination cell on the target sheet.
Outputs
OfficeIMO.Excel.ExcelSheet
Set-OfficeExcelInternalLinksByHeader [-DestinationSheetScript <ScriptBlock>] [-DisplayScript <ScriptBlock>] -Header <String> [-NoStyle] [-PassThru] -TableName <String> [-TargetAddress <String>] [<CommonParameters>]Parameter set:
ContextTableParameters
- DestinationSheetScript ScriptBlock
- Optional mapping from cell text to destination sheet name.
- DisplayScript ScriptBlock
- Optional mapping from cell text to display text.
- Header String
- Header text to locate.
- NoStyle SwitchParameter
- Skip hyperlink styling (blue + underline).
- PassThru SwitchParameter
- Emit the worksheet after creating links.
- TableName String
- Restrict linking to a named table.
- TargetAddress String
- Destination cell on the target sheet.
Outputs
OfficeIMO.Excel.ExcelSheet
Set-OfficeExcelInternalLinksByHeader [-DestinationSheetScript <ScriptBlock>] [-DisplayScript <ScriptBlock>] -Header <String> [-NoStyle] [-PassThru] -Range <String> [-TargetAddress <String>] [<CommonParameters>]Parameter set:
ContextRangeParameters
- DestinationSheetScript ScriptBlock
- Optional mapping from cell text to destination sheet name.
- DisplayScript ScriptBlock
- Optional mapping from cell text to display text.
- Header String
- Header text to locate.
- NoStyle SwitchParameter
- Skip hyperlink styling (blue + underline).
- PassThru SwitchParameter
- Emit the worksheet after creating links.
- Range String
- Restrict linking to a specific A1 range whose first row contains headers.
- TargetAddress String
- Destination cell on the target sheet.
Outputs
OfficeIMO.Excel.ExcelSheet