Search-OfficeDocument

Namespace PSWriteOffice

Inputs

OfficeIMO.Reader.OfficeDocumentReadResult

Outputs

OfficeIMO.Reader.OfficeDocumentSearchResult

Source

Sources/PSWriteOffice/Cmdlets/Reader/SearchOfficeDocumentCommand.cs:15 Edit on GitHub

Searches normalized document blocks and returns Reader-owned page citations for each match.

Remarks

Searches normalized document blocks and returns Reader-owned page citations for each match.

Examples

Authored help example

Find text and inspect its page citations.

PS>


$document = Get-OfficeDocument -Path .\Policy.docx -IncludePageLocations
            $matches = $document | Search-OfficeDocument -Query 'retention period'
            $matches.Hits | Select-Object -ExpandProperty Pages

Uses OfficeIMO.Reader search and location contracts without reparsing document text in PowerShell.

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

Search-OfficeDocument -InputObject <OfficeDocumentReadResult> [-MatchCase] [-MaximumResults <Int32>] -Query <String> [-WholeWord] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

InputObject OfficeDocumentReadResult requiredposition: 0pipeline: True (ByValue): Normalized document returned by Get-OfficeDocument.
MatchCase SwitchParameter optionalposition: namedpipeline: False: Use case-sensitive ordinal matching.
MaximumResults Int32 optionalposition: namedpipeline: False: Maximum number of occurrences to return.
Query String requiredposition: 1pipeline: False: Text to find in normalized document blocks.
WholeWord SwitchParameter optionalposition: namedpipeline: False: Return only occurrences surrounded by non-word characters.

Outputs

OfficeIMO.Reader.OfficeDocumentSearchResult