Cmdlet

Add-OfficeExcelPageBreak

Aliases: ExcelPageBreak

Module: PSWriteOffice
Aliases: ExcelPageBreak
Inputs: OfficeIMO.Excel.ExcelDocument
Source: AddOfficeExcelPageBreakCommand.cs:16 Edit on GitHub

Adds manual row or column page breaks to an Excel worksheet.

Syntax

Add-OfficeExcelPageBreak
[-Column <Int32[]>]
[-PassThru]
[-Row <Int32[]>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]

Parameter set: Context

Add-OfficeExcelPageBreak
[-Column <Int32[]>]
[-PassThru]
[-Path] <String>
[-Row <Int32[]>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]

Parameter set: Path

Add-OfficeExcelPageBreak
[-Column <Int32[]>]
-Document <ExcelDocument>
[-PassThru]
[-Row <Int32[]>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]

Parameter set: Document

Examples

Insert print page breaks for report sections.

ExcelSheet 'Data' { Add-OfficeExcelPageBreak -Row 25,50 -Column 8 }

Adds row page breaks after rows 25 and 50 and a column page break after column 8.

Parameters

-Column Int32[] optional: One-based columns after which manual page breaks should be inserted.
-PassThru SwitchParameter optional: Emit page-break records after adding them.
-Row Int32[] optional: One-based rows after which manual page breaks should be inserted.
-Sheet String optionalaliases: WorksheetName: Worksheet name. Defaults to the current sheet inside an ExcelSheet block.
-SheetIndex Int32 optional: Worksheet index when using a workbook object or path.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Workbook path to update.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook to update outside the DSL context.

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.