API Reference
Cmdlet
Update-OfficeWordText
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
Replace text in an open document.
PS>
$count = $doc | Update-OfficeWordText -OldValue 'FY24' -NewValue 'FY25' -PassThru
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> [-PassThru] [<CommonParameters>]Parameter set:
AutoParameters
- CaseSensitive SwitchParameter
- Use case-sensitive matching.
- IncludeHyperlinkAnchor SwitchParameter
- Also replace hyperlink anchors.
- IncludeHyperlinkText SwitchParameter
- Also replace hyperlink display text.
- IncludeHyperlinkTooltip SwitchParameter
- Also replace hyperlink tooltips.
- IncludeHyperlinkUri SwitchParameter
- Also replace hyperlink URIs.
- NewValue String
- Replacement text.
- OldValue String
- Text to find.
- PassThru SwitchParameter
- Emit the object created or changed by the command.
Outputs
System.Int32
Update-OfficeWordText [-CaseSensitive] [-Document <WordDocument>] [-IncludeHyperlinkAnchor] [-IncludeHyperlinkText] [-IncludeHyperlinkTooltip] [-IncludeHyperlinkUri] -NewValue <String> -OldValue <String> [-PassThru] [<CommonParameters>]Parameter set:
DocumentParameters
- CaseSensitive SwitchParameter
- Use case-sensitive matching.
- Document WordDocument
- Document to update.
- IncludeHyperlinkAnchor SwitchParameter
- Also replace hyperlink anchors.
- IncludeHyperlinkText SwitchParameter
- Also replace hyperlink display text.
- IncludeHyperlinkTooltip SwitchParameter
- Also replace hyperlink tooltips.
- IncludeHyperlinkUri SwitchParameter
- Also replace hyperlink URIs.
- NewValue String
- Replacement text.
- OldValue String
- Text to find.
- PassThru SwitchParameter
- Emit the object created or changed by the command.
Outputs
System.Int32
Update-OfficeWordText [-CaseSensitive] [-IncludeHyperlinkAnchor] [-IncludeHyperlinkText] [-IncludeHyperlinkTooltip] [-IncludeHyperlinkUri] -NewValue <String> -OldValue <String> [-Open] [-PassThru] -Path <String> [<CommonParameters>]Parameter set:
PathParameters
- CaseSensitive SwitchParameter
- Use case-sensitive matching.
- IncludeHyperlinkAnchor SwitchParameter
- Also replace hyperlink anchors.
- IncludeHyperlinkText SwitchParameter
- Also replace hyperlink display text.
- IncludeHyperlinkTooltip SwitchParameter
- Also replace hyperlink tooltips.
- IncludeHyperlinkUri SwitchParameter
- Also replace hyperlink URIs.
- NewValue String
- Replacement text.
- OldValue String
- Text to find.
- Open SwitchParameter
- Open the file after saving when using -Path.
- PassThru SwitchParameter
- Emit the object created or changed by the command.
- Path String
- Path to the .docx file to update in place.
Outputs
System.Int32