Cmdlet

Clear-OfficeExcelPageBreak

Aliases: ExcelPageBreakClear

Module PSWriteOffice

Aliases

ExcelPageBreakClear

Inputs

OfficeIMO.Excel.ExcelDocument

Source

ClearOfficeExcelPageBreakCommand.cs:18 Edit on GitHub

Clears manual row or column page breaks from an Excel worksheet.

Syntax

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

Parameter set: Context

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

Parameter set: Path

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

Parameter set: Document

Examples

Authored help example

Remove stale manual page breaks.

Clear-OfficeExcelPageBreak -Path .\Report.xlsx -Sheet Data -Row 25 -Column 8 -Confirm:$false
Get-OfficeExcelPageBreak -Path .\Report.xlsx -Sheet Data |
    Format-Table Type, Position, SheetName

Removes the selected row and column page breaks and saves the workbook.

Parameters

-All SwitchParameter optional: Clear all manual row and column page breaks from selected worksheets.
-Column Int32[] optional: One-based columns whose manual page breaks should be removed.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Row Int32[] optional: One-based rows whose manual page breaks should be removed.
-Sheet String optionalaliases: WorksheetName: Worksheet name to update. Defaults to the current DSL sheet or all workbook sheets.
-SheetIndex Int32 optional: Worksheet index (0-based) to update. Defaults to the current DSL sheet or all workbook sheets.
-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.