Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

Stars 159

Forks 14

PowerShell Gallery downloads 158,661

Release v3.0.5

Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Close-OfficeExcel

Namespace PSWriteOffice

Inputs

OfficeIMO.Excel.ExcelDocument

Source

Sources/PSWriteOffice/Cmdlets/Excel/CloseOfficeExcelCommand.cs:23 Edit on GitHub

Closes an Excel workbook and optionally saves it.

Remarks

Convenience wrapper so scripts do not need to call Save or Dispose directly.

Examples

Authored help example

Save, validate, and close an open workbook.

PS>


New-OfficeExcel -Path .\report.xlsx {
                Add-OfficeExcelSheet -Name Data {
                    Set-OfficeExcelRow -Row 1 -Values 'Region', 'Revenue'
                    Set-OfficeExcelRow -Row 2 -Values 'EMEA', 98000
                }
            }
            $workbook = Get-OfficeExcel -Path .\report.xlsx
            $workbook | Close-OfficeExcel -Save -Path .\report-final.xlsx -SafePreflight -ValidateOpenXml

Saves pending changes through OfficeIMO's normal save path, validates the package, and releases the workbook.

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

Close-OfficeExcel [-ClearCachedFormulaResults] [-DateSystem <1900|1904|NineteenHundred|NineteenFour>] [-DisableFastPackageWriter] -Document <ExcelDocument> [-EvaluateFormulas] [-ForceFullCalculationOnOpen] [-MarkFormulasDirty] [-Open] [-Password <String>] [-Path <String>] [-SafePreflight] [-SafeRepairDefinedNames] [-Save] [-ValidateOpenXml] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

ClearCachedFormulaResults SwitchParameter optionalposition: namedpipeline: False: Remove cached formula results before saving.
DateSystem String optionalposition: namedpipeline: Falsevalues: 4: Workbook date system for Excel date serials.; Possible values: 1900, 1904, NineteenHundred, NineteenFour
DisableFastPackageWriter SwitchParameter optionalposition: namedpipeline: False: Disable OfficeIMO fast package writers for this save.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook to close.
EvaluateFormulas SwitchParameter optionalposition: namedpipeline: False: Evaluate supported formulas and write cached values before saving.
ForceFullCalculationOnOpen SwitchParameter optionalposition: namedpipeline: False: Request a full workbook recalculation when opened in Excel-compatible applications.
MarkFormulasDirty SwitchParameter optionalposition: namedpipeline: False: Mark formula cells dirty before saving.
Open SwitchParameter optionalposition: namedpipeline: Falsealiases: Show: Open the workbook after saving. Requires -Save or -Path.
Password String optionalposition: namedpipeline: False: Password used to save the workbook as an encrypted package.
Path String optionalposition: namedpipeline: False: Optional output path when saving.
SafePreflight SwitchParameter optionalposition: namedpipeline: False: Run OfficeIMO worksheet preflight cleanup before saving.
SafeRepairDefinedNames SwitchParameter optionalposition: namedpipeline: False: Repair common defined-name issues before saving.
Save SwitchParameter optionalposition: namedpipeline: False: Persist changes before closing.
ValidateOpenXml SwitchParameter optionalposition: namedpipeline: False: Validate the saved package with OpenXmlValidator and throw on errors.