API Reference

Cmdlet

Set-OfficeExcelWorksheetView

Aliases: ExcelSheetView
Namespace PSWriteOffice
Aliases
ExcelSheetView
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Object

Sets worksheet view options such as gridlines, direction, zoom, and view mode.

Remarks

Sets worksheet view options such as gridlines, direction, zoom, and view mode.

Examples

Authored help example

Apply common worksheet view options.

PS>


ExcelSheet 'Data' { Set-OfficeExcelWorksheetView -HideGridlines -ZoomScale 125 -View PageLayout }
        

Hides gridlines, sets zoom, and switches the sheet view.

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-OfficeExcelWorksheetView [-HideGridlines] [-LeftToRight] [-PassThru] [-RightToLeft] [-ShowGridlines] [-View <Nullable`1>] [-ZoomScale <Nullable`1>] [-ZoomScaleNormal <Nullable`1>] [<CommonParameters>]
#
Parameter set: Context

Parameters

HideGridlines SwitchParameter optionalposition: namedpipeline: False
Hide worksheet gridlines.
LeftToRight SwitchParameter optionalposition: namedpipeline: False
Show worksheet left-to-right.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the worksheet after applying view options.
RightToLeft SwitchParameter optionalposition: namedpipeline: False
Show worksheet right-to-left.
ShowGridlines SwitchParameter optionalposition: namedpipeline: False
Show worksheet gridlines.
View Nullable`1 optionalposition: namedpipeline: False
Worksheet view mode.
ZoomScale Nullable`1 optionalposition: namedpipeline: False
Active worksheet zoom percentage. Excel supports values from 10 to 400.
ZoomScaleNormal Nullable`1 optionalposition: namedpipeline: False
Normal-view worksheet zoom percentage. Excel supports values from 10 to 400.

Outputs

System.Object

Set-OfficeExcelWorksheetView -Document <ExcelDocument> [-HideGridlines] [-LeftToRight] [-PassThru] [-RightToLeft] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-ShowGridlines] [-View <Nullable`1>] [-ZoomScale <Nullable`1>] [-ZoomScaleNormal <Nullable`1>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to operate on outside the DSL context.
HideGridlines SwitchParameter optionalposition: namedpipeline: False
Hide worksheet gridlines.
LeftToRight SwitchParameter optionalposition: namedpipeline: False
Show worksheet left-to-right.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the worksheet after applying view options.
RightToLeft SwitchParameter optionalposition: namedpipeline: False
Show worksheet right-to-left.
Sheet String optionalposition: namedpipeline: False
Worksheet name when using Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index (0-based) when using Document.
ShowGridlines SwitchParameter optionalposition: namedpipeline: False
Show worksheet gridlines.
View Nullable`1 optionalposition: namedpipeline: False
Worksheet view mode.
ZoomScale Nullable`1 optionalposition: namedpipeline: False
Active worksheet zoom percentage. Excel supports values from 10 to 400.
ZoomScaleNormal Nullable`1 optionalposition: namedpipeline: False
Normal-view worksheet zoom percentage. Excel supports values from 10 to 400.

Outputs

System.Object