Close-OfficeWord

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Source

Sources/PSWriteOffice/Cmdlets/Word/CloseOfficeWordCommand.cs:28 Edit on GitHub

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

Remarks

Provides a cmdlet wrapper for WordDocument.Dispose/Save so scripts need not call .NET methods directly.

Examples

Authored help example

Example 1: Close without saving.

PS>


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

Disposes the loaded document instance without saving changes.

Example 2: Close the most recently tracked document.

PS>


Close-OfficeWord

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

Example 3: Save to a new path and open the file.

PS>


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

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

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-OfficeWord [-Current] [-Password <String>] [-Path <String>] [-Save] [-Show] [<CommonParameters>]

Parameter set: Current

Parameters

Current SwitchParameter optionalposition: namedpipeline: False: Close the most recently tracked document.
Password String optionalposition: namedpipeline: False: Password used to save the document as an encrypted package.
Path String optionalposition: namedpipeline: False: Optional target path when saving.
Save SwitchParameter optionalposition: namedpipeline: False: Persist changes before closing.
Show SwitchParameter optionalposition: namedpipeline: False: Open the file after saving.

Close-OfficeWord -Document <WordDocument> [-Password <String>] [-Path <String>] [-Save] [-Show] [<CommonParameters>]

Parameter set: Document

Parameters

Document WordDocument requiredposition: 0pipeline: True (ByValue): Word document to close.
Password String optionalposition: namedpipeline: False: Password used to save the document as an encrypted package.
Path String optionalposition: namedpipeline: False: Optional target path when saving.
Save SwitchParameter optionalposition: namedpipeline: False: Persist changes before closing.
Show SwitchParameter optionalposition: namedpipeline: False: Open the file after saving.

Close-OfficeWord -All [-Password <String>] [-Save] [-Show] [<CommonParameters>]

Parameter set: All

Parameters

All SwitchParameter requiredposition: namedpipeline: False: Close all tracked documents for the current runspace.
Password String optionalposition: namedpipeline: False: Password used to save the document as an encrypted package.
Save SwitchParameter optionalposition: namedpipeline: False: Persist changes before closing.
Show SwitchParameter optionalposition: namedpipeline: False: Open the file after saving.