Project

PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

View on GitHub Releases Get package

Stars 144

Forks 12

Open issues 16

PowerShell Gallery downloads 150,904

Release v0.2.0

Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Get-OfficeExcel

Namespace PSWriteOffice

Inputs

None

Outputs

System.Object

Source

Sources/PSWriteOffice/Cmdlets/Excel/GetOfficeExcelCommand.cs:17 Edit on GitHub

Opens an existing Excel workbook.

Remarks

Returns the underlying ExcelDocument so callers can inspect or reuse it in DSL pipelines.

Examples

Authored help example

Load a workbook in read-only mode.

PS>


$workbook = Get-OfficeExcel -Path .\report.xlsx -ReadOnly

Loads report.xlsx for inspection without enabling writes.

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

Get-OfficeExcel [-AutoSave] -InputPath <String> [-ReadOnly] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AutoSave SwitchParameter optionalposition: namedpipeline: False: Enable automatic saves on the underlying document.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Path to the workbook to load.
ReadOnly SwitchParameter optionalposition: namedpipeline: False: Open the file in read-only mode.

Outputs

System.Object