Get-OfficeExcelPageBreak

Aliases: ExcelPageBreaks

Namespace PSWriteOffice

Aliases

ExcelPageBreaks

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

Sources/PSWriteOffice/Cmdlets/Excel/GetOfficeExcelPageBreakCommand.cs:16 Edit on GitHub

Gets manual row and column page breaks from Excel worksheets.

Remarks

Gets manual row and column page breaks from Excel worksheets.

Examples

Authored help example

List manual print page breaks.

PS>


$breaks = Get-OfficeExcelPageBreak -Path .\Report.xlsx -Sheet Data
            $breaks |
                Sort-Object Type, Position

Returns row and column page-break records for print-layout audits.

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

Get-OfficeExcelPageBreak [-Column] [-Row] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]

Parameter set: Context

Parameters

Column SwitchParameter optionalposition: namedpipeline: False: Only return column page breaks.
Row SwitchParameter optionalposition: namedpipeline: False: Only return row page breaks.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName: Worksheet name to inspect. Defaults to the current DSL sheet or all workbook sheets.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) to inspect. Defaults to the current DSL sheet or all workbook sheets.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelPageBreak [-Column] -InputPath <String> [-Row] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]

Parameter set: Path

Parameters

Column SwitchParameter optionalposition: namedpipeline: False: Only return column page breaks.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Workbook path to inspect.
Row SwitchParameter optionalposition: namedpipeline: False: Only return row page breaks.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName: Worksheet name to inspect. Defaults to the current DSL sheet or all workbook sheets.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) to inspect. Defaults to the current DSL sheet or all workbook sheets.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelPageBreak [-Column] -Document <ExcelDocument> [-Row] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]

Parameter set: Document

Parameters

Column SwitchParameter optionalposition: namedpipeline: False: Only return column page breaks.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to inspect outside the DSL context.
Row SwitchParameter optionalposition: namedpipeline: False: Only return row page breaks.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName: Worksheet name to inspect. Defaults to the current DSL sheet or all workbook sheets.
SheetIndex Nullable`1 optionalposition: namedpipeline: False: Worksheet index (0-based) to inspect. Defaults to the current DSL sheet or all workbook sheets.

Outputs

System.Management.Automation.PSObject