Set-OfficeExcelPrintTitles

Aliases: ExcelPrintTitles

Namespace PSWriteOffice

Aliases

ExcelPrintTitles

Inputs

OfficeIMO.Excel.ExcelDocument

Source

Sources/PSWriteOffice/Cmdlets/Excel/SetOfficeExcelPrintTitlesCommand.cs:21 Edit on GitHub

Sets or clears repeating print title rows and columns for a worksheet.

Remarks

Sets or clears repeating print title rows and columns for a worksheet.

Examples

Authored help example

Repeat report headers on every printed page.

PS>


$proof = @(
                Set-OfficeExcelPrintTitles -Path .\Report.xlsx -Sheet Data -FirstRow 1 -LastRow 1 -FirstColumn 1 -LastColumn 1
                Get-OfficeExcelSummary -Path .\Report.xlsx |
                    Select-Object -Property SheetCount, TableCount
            )
            $proof

Stores Excel print titles for the Data worksheet and then reads back workbook structure as a quick proof step.

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-OfficeExcelPrintTitles [-Clear] [-FirstColumn <Int32>] [-FirstRow <Int32>] [-LastColumn <Int32>] [-LastRow <Int32>] [-PassThru] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Context

Parameters

Clear SwitchParameter optionalposition: namedpipeline: False: Clear existing print titles for the worksheet.
FirstColumn Int32 optionalposition: namedpipeline: False: First 1-based column to repeat.
FirstRow Int32 optionalposition: namedpipeline: False: First 1-based row to repeat.
LastColumn Int32 optionalposition: namedpipeline: False: Last 1-based column to repeat.
LastRow Int32 optionalposition: namedpipeline: False: Last 1-based row to repeat.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the worksheet after setting print titles.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName: Worksheet name. Defaults to the current sheet inside an ExcelSheet block.
SheetIndex Int32 optionalposition: namedpipeline: False: Worksheet index when using a workbook object or path.

Set-OfficeExcelPrintTitles [-Clear] [-FirstColumn <Int32>] [-FirstRow <Int32>] -InputPath <String> [-LastColumn <Int32>] [-LastRow <Int32>] [-PassThru] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Path

Parameters

Clear SwitchParameter optionalposition: namedpipeline: False: Clear existing print titles for the worksheet.
FirstColumn Int32 optionalposition: namedpipeline: False: First 1-based column to repeat.
FirstRow Int32 optionalposition: namedpipeline: False: First 1-based row to repeat.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Workbook path to update.
LastColumn Int32 optionalposition: namedpipeline: False: Last 1-based column to repeat.
LastRow Int32 optionalposition: namedpipeline: False: Last 1-based row to repeat.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the worksheet after setting print titles.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName: Worksheet name. Defaults to the current sheet inside an ExcelSheet block.
SheetIndex Int32 optionalposition: namedpipeline: False: Worksheet index when using a workbook object or path.

Set-OfficeExcelPrintTitles [-Clear] -Document <ExcelDocument> [-FirstColumn <Int32>] [-FirstRow <Int32>] [-LastColumn <Int32>] [-LastRow <Int32>] [-PassThru] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Document

Parameters

Clear SwitchParameter optionalposition: namedpipeline: False: Clear existing print titles for the worksheet.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to update outside the DSL context.
FirstColumn Int32 optionalposition: namedpipeline: False: First 1-based column to repeat.
FirstRow Int32 optionalposition: namedpipeline: False: First 1-based row to repeat.
LastColumn Int32 optionalposition: namedpipeline: False: Last 1-based column to repeat.
LastRow Int32 optionalposition: namedpipeline: False: Last 1-based row to repeat.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the worksheet after setting print titles.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName: Worksheet name. Defaults to the current sheet inside an ExcelSheet block.
SheetIndex Int32 optionalposition: namedpipeline: False: Worksheet index when using a workbook object or path.