Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

Set-OfficeExcelPrintArea

Aliases: ExcelPrintArea
Module PSWriteOffice
Aliases
ExcelPrintArea
Inputs
OfficeIMO.Excel.ExcelDocument

Sets the print area for a worksheet.

Syntax

Set-OfficeExcelPrintArea [-PassThru] [-Range] <String> [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]
#
Parameter set: Context
Set-OfficeExcelPrintArea [-PassThru] [-Path] <String> [-Range] <String> [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]
#
Parameter set: Path
Set-OfficeExcelPrintArea -Document <ExcelDocument> [-PassThru] [-Range] <String> [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]
#
Parameter set: Document

Examples

Authored help example

Set a print area and keep the workbook printable.

$proof = @(
    Set-OfficeExcelPrintArea -Path .\Report.xlsx -Sheet Summary -Range A1:H40
    Set-OfficeExcelPrintTitles -Path .\Report.xlsx -Sheet Summary -FirstRow 1 -LastRow 2
)
$proof

Stores the worksheet-local Excel print area and repeats the report header rows for printing.

Parameters

-PassThru SwitchParameter optional
Emit the worksheet after setting the print area.
-Range String requiredposition: 1
A1 range to print.
-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.