Skip to content

Set-OfficeExcelOrientation.md

Latest commit

 

History

History
130 lines (100 loc) · 2.54 KB

Set-OfficeExcelOrientation.md

File metadata and controls

130 lines (100 loc) · 2.54 KB
external help file PSWriteOffice-help.xml
Module Name PSWriteOffice
online version https://github.com/EvotecIT/PSWriteOffice
schema 2.0.0

Set-OfficeExcelOrientation

SYNOPSIS

Sets the page orientation on a worksheet.

SYNTAX

Context (Default)

Set-OfficeExcelOrientation [-Orientation] <ExcelPageOrientation> [-PassThru] [<CommonParameters>]

Document

Set-OfficeExcelOrientation [-Orientation] <ExcelPageOrientation> -Document <ExcelDocument> [-Sheet <string>] [-SheetIndex <int>] [-PassThru] [<CommonParameters>]

DESCRIPTION

Sets the page orientation on a worksheet.

EXAMPLES

EXAMPLE 1

PS>ExcelSheet 'Data' { Set-OfficeExcelOrientation -Orientation Landscape }

Configures the sheet to print in landscape.

PARAMETERS

-Document

Workbook to operate on outside the DSL context.

Type: ExcelDocument
Parameter Sets: Document
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-Orientation

Orientation to apply.

Type: ExcelPageOrientation
Parameter Sets: Context, Document
Aliases: None
Possible values: Portrait, Landscape

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PassThru

Emit the worksheet after applying the orientation.

Type: SwitchParameter
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Sheet

Worksheet name when using Document.

Type: String
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SheetIndex

Worksheet index (0-based) when using Document.

Type: Nullable`1
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • OfficeIMO.Excel.ExcelDocument

OUTPUTS

  • System.Object

RELATED LINKS

  • None