Cmdlet

Find-OfficeWord

Module: PSWriteOffice
Inputs: OfficeIMO.Word.WordDocument
Outputs: OfficeIMO.Word.WordParagraph OfficeIMO.Word.WordSearchResult
Source: FindOfficeWordCommand.cs:32 Edit on GitHub

Finds text matches inside a Word document.

Syntax

Find-OfficeWord
[-CaseSensitive]
[-Path] <String>
[-Text] <String>
[<CommonParameters>]

Parameter set: PathText

Find-OfficeWord
[-AsResult]
[-CaseSensitive]
[-Path] <String>
[-Pattern] <String>
[<CommonParameters>]

Parameter set: PathRegex

Find-OfficeWord
[-CaseSensitive]
-Document <WordDocument>
[-Text] <String>
[<CommonParameters>]

Parameter set: DocumentText

Find-OfficeWord
[-AsResult]
[-CaseSensitive]
-Document <WordDocument>
[-Pattern] <String>
[<CommonParameters>]

Parameter set: DocumentRegex

Description

Returns matching paragraphs or a WordSearchResult when using regex with -AsResult.

Examples

Find matching paragraphs and export a review list.

$matches = Find-OfficeWord -Path .\Report.docx -Text 'Quarter'
$matches |
    Select-Object -Property Text |
    Export-Csv -Path .\ReviewMatches.csv -NoTypeInformation

Finds paragraphs containing the search text and writes a lightweight review CSV.

Use regex and keep the grouped WordSearchResult.

$result = Find-OfficeWord -Path .\Report.docx -Pattern 'FY\d{4}' -AsResult
$result.Paragraphs |
    Select-Object -Property Text

Returns the full regex result so paragraphs, table matches, headers, and footers can be inspected separately.

Parameters

-CaseSensitive SwitchParameter optional: Use case-sensitive matching.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: PathText, PathRegex: Path to the .docx file.
-Text String requiredposition: 1sets: PathText, DocumentText: Text to find.
-AsResult SwitchParameter optionalsets: PathRegex, DocumentRegex: Emit the full WordSearchResult result for regex searches.
-Pattern String requiredposition: 1sets: PathRegex, DocumentRegex: Regular expression pattern to find.
-Document WordDocument requiredpipeline: True (ByValue)sets: DocumentText, DocumentRegex: Word document to search.

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.