Cmdlet

Find-OfficeWordList

Module PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument OfficeIMO.Word.WordSection

Outputs

OfficeIMO.Word.WordList

Source

FindOfficeWordListCommand.cs:41 Edit on GitHub

Finds Word lists containing matching list-item text.

Syntax

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

Parameter set: PathText

Find-OfficeWordList [-CaseSensitive] [-Path] <String> [-Pattern] <String> [<CommonParameters>]

Parameter set: PathRegex

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

Parameter set: DocumentText

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

Parameter set: DocumentRegex

Find-OfficeWordList [-CaseSensitive] -Section <WordSection> [-Text] <String> [<CommonParameters>]

Parameter set: SectionText

Find-OfficeWordList [-CaseSensitive] [-Pattern] <String> -Section <WordSection> [<CommonParameters>]

Parameter set: SectionRegex

Description

Searches list items in a Word document or section and returns matching WordList objects. This is useful when a document has an existing checklist or numbered list and the script needs to append to that list rather than create a new one elsewhere in the document.

Use -Text for literal contains matching or -Pattern for regular expressions. The returned list objects can be piped directly to Add-OfficeWordListItem.

Examples

Authored help example

Find an existing checklist and append another item.

$doc = Get-OfficeWord -Path .\Report.docx
Find-OfficeWordList -Document $doc -Text 'Initial review' |
    Add-OfficeWordListItem -Text 'Final approval'

Searches list-item paragraphs and returns matching OfficeIMO list objects for further editing.

Append several follow-up items to an existing checklist.

$doc = Get-OfficeWord -Path .\Handover.docx
$list = Find-OfficeWordList -Document $doc -Text 'Initial review' | Select-Object -First 1
$list | Add-OfficeWordListItem -Text 'Business sign-off'
$list | Add-OfficeWordListItem -Text 'Go-live approval'
$doc | Close-OfficeWord -Save

Finds a checklist by an item it already contains and appends new items to the same list.

Parameters

-CaseSensitive SwitchParameter optional: Use case-sensitive matching.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: PathText, PathRegex: Path to the document to open read-only for searching.
-Text String requiredposition: 1sets: PathText, DocumentText, SectionText: Literal text to find in list items.
-Pattern String requiredposition: 1sets: PathRegex, DocumentRegex, SectionRegex: Regular expression pattern to find in list items.
-Document WordDocument requiredpipeline: True (ByValue)sets: DocumentText, DocumentRegex: Open document to inspect. The caller controls the document lifetime.
-Section WordSection requiredpipeline: True (ByValue)sets: SectionText, SectionRegex: Section to inspect when the caller only wants lists in a specific section.

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.