Set-OfficeExcelPrintLayout

Aliases: ExcelPrintLayout

Namespace PSWriteOffice

Aliases

ExcelPrintLayout

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

OfficeIMO.Excel.ExcelSheet System.Management.Automation.PSObject

Source

Sources/PSWriteOffice/Cmdlets/Excel/SetOfficeExcelPrintLayoutCommand.cs:19 Edit on GitHub

Applies a reusable worksheet print layout preset.

Remarks

Applies a reusable worksheet print layout preset.

Examples

Authored help example

Apply a report print layout.

PS>


ExcelSheet 'Report' { Set-OfficeExcelPrintLayout -Preset Report -PrintArea A1:H40 }

Applies landscape orientation, narrow margins, one-page-wide scaling, and repeated header row.

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-OfficeExcelPrintLayout [-FitToHeight <UInt32>] [-FitToWidth <UInt32>] [-Margins <Normal|Narrow|Moderate|Wide>] [-NoPresetPrintTitles] [-Orientation <Portrait|Landscape>] [-PageOrder <DownThenOver|OverThenDown>] [-PassThru] [-Preset <Worksheet|Report|Dashboard|DataTable>] [-PrintArea <String>] [-RepeatFirstColumn <Int32>] [-RepeatFirstRow <Int32>] [-RepeatLastColumn <Int32>] [-RepeatLastRow <Int32>] [-Scale <UInt32>] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Context

Parameters

FitToHeight UInt32 optionalposition: namedpipeline: False: Optional pages-tall fit override. Use 0 for unlimited height.
FitToWidth UInt32 optionalposition: namedpipeline: False: Optional pages-wide fit override.
Margins ExcelMarginPreset optionalposition: namedpipeline: Falsevalues: 4: Optional margin preset override.; Possible values: Normal, Narrow, Moderate, Wide
NoPresetPrintTitles SwitchParameter optionalposition: namedpipeline: False: Do not apply print-title rows from the selected preset.
Orientation OfficePageOrientation optionalposition: namedpipeline: Falsevalues: 2: Optional orientation override.; Possible values: Portrait, Landscape
PageOrder ExcelPageOrder optionalposition: namedpipeline: Falsevalues: 2: Optional multi-page print order override.; Possible values: DownThenOver, OverThenDown
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the worksheet after applying the layout.
Preset ExcelPrintLayoutPreset optionalposition: namedpipeline: Falsevalues: 4: Print layout preset.; Possible values: Worksheet, Report, Dashboard, DataTable
PrintArea String optionalposition: namedpipeline: False: Optional print area in A1 notation.
RepeatFirstColumn Int32 optionalposition: namedpipeline: False: Optional first 1-based repeated print-title column.
RepeatFirstRow Int32 optionalposition: namedpipeline: False: Optional first 1-based repeated print-title row.
RepeatLastColumn Int32 optionalposition: namedpipeline: False: Optional last 1-based repeated print-title column.
RepeatLastRow Int32 optionalposition: namedpipeline: False: Optional last 1-based repeated print-title row.
Scale UInt32 optionalposition: namedpipeline: False: Optional manual scale percentage override.
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.

Outputs

OfficeIMO.Excel.ExcelSheet, System.Management.Automation.PSObject

Set-OfficeExcelPrintLayout [-FitToHeight <UInt32>] [-FitToWidth <UInt32>] -InputPath <String> [-Margins <Normal|Narrow|Moderate|Wide>] [-NoPresetPrintTitles] [-Orientation <Portrait|Landscape>] [-PageOrder <DownThenOver|OverThenDown>] [-PassThru] [-Preset <Worksheet|Report|Dashboard|DataTable>] [-PrintArea <String>] [-RepeatFirstColumn <Int32>] [-RepeatFirstRow <Int32>] [-RepeatLastColumn <Int32>] [-RepeatLastRow <Int32>] [-Scale <UInt32>] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Path

Parameters

FitToHeight UInt32 optionalposition: namedpipeline: False: Optional pages-tall fit override. Use 0 for unlimited height.
FitToWidth UInt32 optionalposition: namedpipeline: False: Optional pages-wide fit override.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Workbook path to update.
Margins ExcelMarginPreset optionalposition: namedpipeline: Falsevalues: 4: Optional margin preset override.; Possible values: Normal, Narrow, Moderate, Wide
NoPresetPrintTitles SwitchParameter optionalposition: namedpipeline: False: Do not apply print-title rows from the selected preset.
Orientation OfficePageOrientation optionalposition: namedpipeline: Falsevalues: 2: Optional orientation override.; Possible values: Portrait, Landscape
PageOrder ExcelPageOrder optionalposition: namedpipeline: Falsevalues: 2: Optional multi-page print order override.; Possible values: DownThenOver, OverThenDown
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the worksheet after applying the layout.
Preset ExcelPrintLayoutPreset optionalposition: namedpipeline: Falsevalues: 4: Print layout preset.; Possible values: Worksheet, Report, Dashboard, DataTable
PrintArea String optionalposition: namedpipeline: False: Optional print area in A1 notation.
RepeatFirstColumn Int32 optionalposition: namedpipeline: False: Optional first 1-based repeated print-title column.
RepeatFirstRow Int32 optionalposition: namedpipeline: False: Optional first 1-based repeated print-title row.
RepeatLastColumn Int32 optionalposition: namedpipeline: False: Optional last 1-based repeated print-title column.
RepeatLastRow Int32 optionalposition: namedpipeline: False: Optional last 1-based repeated print-title row.
Scale UInt32 optionalposition: namedpipeline: False: Optional manual scale percentage override.
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.

Outputs

OfficeIMO.Excel.ExcelSheet, System.Management.Automation.PSObject

Set-OfficeExcelPrintLayout -Document <ExcelDocument> [-FitToHeight <UInt32>] [-FitToWidth <UInt32>] [-Margins <Normal|Narrow|Moderate|Wide>] [-NoPresetPrintTitles] [-Orientation <Portrait|Landscape>] [-PageOrder <DownThenOver|OverThenDown>] [-PassThru] [-Preset <Worksheet|Report|Dashboard|DataTable>] [-PrintArea <String>] [-RepeatFirstColumn <Int32>] [-RepeatFirstRow <Int32>] [-RepeatLastColumn <Int32>] [-RepeatLastRow <Int32>] [-Scale <UInt32>] [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to update outside the DSL context.
FitToHeight UInt32 optionalposition: namedpipeline: False: Optional pages-tall fit override. Use 0 for unlimited height.
FitToWidth UInt32 optionalposition: namedpipeline: False: Optional pages-wide fit override.
Margins ExcelMarginPreset optionalposition: namedpipeline: Falsevalues: 4: Optional margin preset override.; Possible values: Normal, Narrow, Moderate, Wide
NoPresetPrintTitles SwitchParameter optionalposition: namedpipeline: False: Do not apply print-title rows from the selected preset.
Orientation OfficePageOrientation optionalposition: namedpipeline: Falsevalues: 2: Optional orientation override.; Possible values: Portrait, Landscape
PageOrder ExcelPageOrder optionalposition: namedpipeline: Falsevalues: 2: Optional multi-page print order override.; Possible values: DownThenOver, OverThenDown
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the worksheet after applying the layout.
Preset ExcelPrintLayoutPreset optionalposition: namedpipeline: Falsevalues: 4: Print layout preset.; Possible values: Worksheet, Report, Dashboard, DataTable
PrintArea String optionalposition: namedpipeline: False: Optional print area in A1 notation.
RepeatFirstColumn Int32 optionalposition: namedpipeline: False: Optional first 1-based repeated print-title column.
RepeatFirstRow Int32 optionalposition: namedpipeline: False: Optional first 1-based repeated print-title row.
RepeatLastColumn Int32 optionalposition: namedpipeline: False: Optional last 1-based repeated print-title column.
RepeatLastRow Int32 optionalposition: namedpipeline: False: Optional last 1-based repeated print-title row.
Scale UInt32 optionalposition: namedpipeline: False: Optional manual scale percentage override.
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.

Outputs

OfficeIMO.Excel.ExcelSheet, System.Management.Automation.PSObject