Get Started

API Reference

Cmdlet

Get-OfficeWordParagraph

Namespace PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument OfficeIMO.Word.WordSection
Outputs
OfficeIMO.Word.WordParagraph
Source
Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordParagraphCommand.cs:23 Edit on GitHub

Gets paragraphs from a Word document or section.

Remarks

Gets paragraphs from a Word document or section.

Examples

Authored help example

Example 1: Extract visible paragraph text.

PS>


$paragraphs = Get-OfficeWordParagraph -Path .\Report.docx
            $paragraphs |
                Where-Object { $_.Text } |
                Select-Object -Property Text |
                Set-Content -Path .\ReportParagraphs.txt

Enumerates document paragraphs and writes their text for a lightweight review workflow.

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

Get-OfficeWordParagraph -InputPath <String> [<CommonParameters>]
#
Parameter set: Path

Parameters

InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Path to the document.

Outputs

OfficeIMO.Word.WordParagraph

Get-OfficeWordParagraph -Document <WordDocument> [<CommonParameters>]
#
Parameter set: Document

Parameters

Document WordDocument requiredposition: namedpipeline: True (ByValue)
Document to inspect.

Outputs

OfficeIMO.Word.WordParagraph

Get-OfficeWordParagraph -Section <WordSection> [<CommonParameters>]
#
Parameter set: Section

Parameters

Section WordSection requiredposition: namedpipeline: True (ByValue)
Section to enumerate.

Outputs

OfficeIMO.Word.WordParagraph