Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

Stars 654

Forks 82

Open issues 1

Total downloads 4,320,051

Release OfficeIMO-v3.5.3

Language: C# Updated: 2026-11-03

Cmdlet

Get-OfficeWord

Module: PSWriteOffice
Inputs: None
Source: GetOfficeWordCommand.cs:23 Edit on GitHub

Opens an existing Word document.

Syntax

Get-OfficeWord
[[-Content] <ScriptBlock>]
[-Password <String>]
[-Path] <String>
[-ReadOnly]
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Returns an OfficeIMO WordDocument for inspection, advanced operations, or optional DSL edits.

Examples

Load a document in read-only mode.

$doc = Get-OfficeWord -Path .\Report.docx -ReadOnly

Loads Report.docx and exposes the document object for querying.

Run the Word DSL against an existing document.

$doc = Get-OfficeWord -Path .\Report.docx { WordParagraph -Text 'Appended by DSL' }; $doc | Save-OfficeWord

Loads the document, appends content through the DSL, and returns the open document for saving or further edits.

Parameters

-Content ScriptBlock optionalposition: 1: Optional DSL scriptblock to execute against the loaded document.
-Password String optional: Password used to open an encrypted document package.
-Path String requiredposition: 0aliases: FilePath, InputPath: Path to the .docx. Accepts PS paths.
-ReadOnly SwitchParameter optional: Open in read-only mode.

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.