Get-OfficeWordText

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordParagraph OfficeIMO.Word.WordSection OfficeIMO.Word.WordDocument

Outputs

OfficeIMO.Word.WordParagraph

Source

Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordTextCommand.cs:17 Edit on GitHub

Gets text segments from Word paragraphs.

Remarks

Gets text segments from Word paragraphs.

Examples

Authored help example

Enumerate text segments for all paragraphs.

PS>


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

Returns each text segment as a WordParagraph instance.

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-OfficeWordText -Paragraph <WordParagraph> [<CommonParameters>]

Parameter set: Paragraph

Parameters

Paragraph WordParagraph requiredposition: namedpipeline: True (ByValue): Paragraph to enumerate.

Outputs

OfficeIMO.Word.WordParagraph

Get-OfficeWordText -Section <WordSection> [<CommonParameters>]

Parameter set: Section

Parameters

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

Outputs

OfficeIMO.Word.WordParagraph

Get-OfficeWordText -Document <WordDocument> [<CommonParameters>]

Parameter set: Document

Parameters

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

Outputs

OfficeIMO.Word.WordParagraph

Get-OfficeWordText -InputPath <String> [<CommonParameters>]

Parameter set: Path

Parameters

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

Outputs

OfficeIMO.Word.WordParagraph