Cmdlet

Get-OfficeExcelWorksheetView

Aliases: ExcelWorksheetView

Module PSWriteOffice

Aliases

ExcelWorksheetView

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

GetOfficeExcelWorksheetViewCommand.cs:20 Edit on GitHub

Gets worksheet view settings such as frozen panes and gridline visibility.

Syntax

Get-OfficeExcelWorksheetView [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Context

Get-OfficeExcelWorksheetView [-Path] <String> [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Path

Get-OfficeExcelWorksheetView -Document <ExcelDocument> [-Sheet <String>] [-SheetIndex <Int32>] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Inspect worksheet view settings.

$views = Get-OfficeExcelWorksheetView -Path .\Report.xlsx
$views |
    Format-Table SheetName, FrozenRowCount, FrozenColumnCount, ShowGridlines, ZoomScale

Returns view metadata useful for workbook audits and maintenance scripts.

Parameters

-Sheet String optional: Worksheet name to inspect. Defaults to the current DSL sheet or all workbook sheets.
-SheetIndex Int32 optional: Worksheet index (0-based) to inspect. Defaults to the current DSL sheet or all workbook sheets.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Workbook path to inspect.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document: Workbook to inspect 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.