PSWriteOffice

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

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

Update-OfficeWordText

Aliases: Replace-OfficeWordText

Namespace PSWriteOffice

Aliases

Replace-OfficeWordText

Inputs

OfficeIMO.Word.WordDocument

Outputs

System.Int32

Source

Sources/PSWriteOffice/Cmdlets/Word/UpdateOfficeWordTextCommand.cs:25 Edit on GitHub

Replaces text in a Word document.

Remarks

Supports direct document objects, file paths, and the active DSL document. Hyperlink labels and metadata can be updated when requested.

Examples

Authored help example

Replace text in an open document.

PS>


$doc | Update-OfficeWordText -OldValue 'FY24' -NewValue 'FY25'

Updates matching text in the loaded document and returns the number of replacements.

Replace hyperlink targets in a file.

PS>


Update-OfficeWordText -Path .\Report.docx -OldValue 'old.example.com' -NewValue 'new.example.com' -IncludeHyperlinkUri

Loads the document, updates matching hyperlink URLs, saves the file, and closes it.

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

Update-OfficeWordText [-CaseSensitive] [-IncludeHyperlinkAnchor] [-IncludeHyperlinkText] [-IncludeHyperlinkTooltip] [-IncludeHyperlinkUri] -NewValue <String> -OldValue <String> [<CommonParameters>]

Parameter set: Auto

Parameters

CaseSensitive SwitchParameter optionalposition: namedpipeline: False: Use case-sensitive matching.
IncludeHyperlinkAnchor SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink anchors.
IncludeHyperlinkText SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink display text.
IncludeHyperlinkTooltip SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink tooltips.
IncludeHyperlinkUri SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink URIs.
NewValue String requiredposition: namedpipeline: False: Replacement text.
OldValue String requiredposition: namedpipeline: False: Text to find.

Outputs

System.Int32

Update-OfficeWordText [-CaseSensitive] [-Document <WordDocument>] [-IncludeHyperlinkAnchor] [-IncludeHyperlinkText] [-IncludeHyperlinkTooltip] [-IncludeHyperlinkUri] -NewValue <String> -OldValue <String> [<CommonParameters>]

Parameter set: Document

Parameters

CaseSensitive SwitchParameter optionalposition: namedpipeline: False: Use case-sensitive matching.
Document WordDocument optionalposition: namedpipeline: True (ByValue): Document to update.
IncludeHyperlinkAnchor SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink anchors.
IncludeHyperlinkText SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink display text.
IncludeHyperlinkTooltip SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink tooltips.
IncludeHyperlinkUri SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink URIs.
NewValue String requiredposition: namedpipeline: False: Replacement text.
OldValue String requiredposition: namedpipeline: False: Text to find.

Outputs

System.Int32

Update-OfficeWordText [-CaseSensitive] [-IncludeHyperlinkAnchor] [-IncludeHyperlinkText] [-IncludeHyperlinkTooltip] [-IncludeHyperlinkUri] -InputPath <String> -NewValue <String> -OldValue <String> [-Show] [<CommonParameters>]

Parameter set: Path

Parameters

CaseSensitive SwitchParameter optionalposition: namedpipeline: False: Use case-sensitive matching.
IncludeHyperlinkAnchor SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink anchors.
IncludeHyperlinkText SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink display text.
IncludeHyperlinkTooltip SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink tooltips.
IncludeHyperlinkUri SwitchParameter optionalposition: namedpipeline: False: Also replace hyperlink URIs.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Path to the .docx file to update in place.
NewValue String requiredposition: namedpipeline: False: Replacement text.
OldValue String requiredposition: namedpipeline: False: Text to find.
Show SwitchParameter optionalposition: namedpipeline: False: Open the file after saving when using -Path.

Outputs

System.Int32