Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

Close-OfficeWord

Module
PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument
Source
CloseOfficeWordCommand.cs:30 Edit on GitHub

Closes one or more tracked Word documents, optionally saving them.

Syntax

Close-OfficeWord
[-AllowLoss]
[-Password <SecureString>]
[-Path <String>]
[-Save]
[-Show]
[<CommonParameters>]
#
Parameter set: Current
Close-OfficeWord
[-AllowLoss]
[-Document] <WordDocument>
[-Password <SecureString>]
[-Path <String>]
[-Save]
[-Show]
[<CommonParameters>]
#
Parameter set: Document
Close-OfficeWord
-All
[-AllowLoss]
[-Password <SecureString>]
[-Save]
[-Show]
[<CommonParameters>]
#
Parameter set: All

Description

Provides a cmdlet wrapper for WordDocument.Dispose/Save so scripts need not call .NET methods directly. Documents must use explicit persistence to prevent writes during disposal.

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Pipeline, Object, and DSL Workflows Guide

    Choose the shortest PSWriteOffice surface for quick exports, incremental composition, complete document authoring, or existing-file updates.

  • Read and Inspect Word Documents Guide

    Open existing DOCX files, enumerate document structures, search content, and collect statistics without changing the source document.

  • Quick Start Guide

    Create your first Word document, Excel workbook, and PowerPoint presentation with OfficeIMO in minutes. Includes examples and API links.

Examples

Close without saving.

$doc = Open-OfficeWord -Path .\Report.docx; Close-OfficeWord -Document $doc

Disposes the loaded document instance without saving changes.

Close the most recently tracked document.

Close-OfficeWord

Closes the current tracked document when a document handle is not passed explicitly.

Save to a new path and open the file.

Close-OfficeWord -Document $doc -Save -Path .\Report-final.docx -Show

Saves updates to Report-final.docx, opens it, and disposes the document.

Parameters

-AllowLoss SwitchParameter optional
Explicitly accept reported native-save reductions.
-Password SecureString optional
Password used to save the document as an encrypted package.
-Path String optionalsets: Current, Document
Optional target path when saving.
-Save SwitchParameter optional
Persist changes before closing.
-Show SwitchParameter optional
Open the file after saving. Requires -Save or -Path.
-Document WordDocument requiredposition: 0pipeline: True (ByValue)sets: Document
Word document to close.
-All SwitchParameter requiredsets: All
Close all tracked documents for the current runspace.

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.