Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

Get-OfficeWordText

Module PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument OfficeIMO.Word.WordParagraph OfficeIMO.Word.WordSection
Outputs
OfficeIMO.Word.WordParagraph

Gets text segments from Word paragraphs.

Syntax

Get-OfficeWordText -Paragraph <WordParagraph> [<CommonParameters>]
#
Parameter set: Paragraph
Get-OfficeWordText -Section <WordSection> [<CommonParameters>]
#
Parameter set: Section
Get-OfficeWordText -Document <WordDocument> [<CommonParameters>]
#
Parameter set: Document
Get-OfficeWordText [-Path] <String> [<CommonParameters>]
#
Parameter set: Path

Examples

Authored help example

Enumerate text segments for all paragraphs.

Get-OfficeWordParagraph -Path .\Report.docx | Get-OfficeWordText

Returns each text segment as a WordParagraph instance.

Parameters

-Paragraph WordParagraph requiredpipeline: True (ByValue)sets: Paragraph
Paragraph to enumerate.
-Section WordSection requiredpipeline: True (ByValue)sets: Section
Section to enumerate.
-Document WordDocument requiredpipeline: True (ByValue)sets: Document
Document to enumerate.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path
Path to the document.

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.