OfficeIMO

API Reference

Command

Get-OfficeWordRun

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

Gets runs from Word paragraphs.

Remarks

Gets runs from Word paragraphs.

Examples

Enumerate runs for all paragraphs.


PS>Get-OfficeWordParagraph -Path .\Report.docx | Get-OfficeWordRun
        

Returns each run 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-OfficeWordRun -Paragraph <WordParagraph> [<CommonParameters>]
#
Parameter set: Paragraph

Parameters

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

Outputs

OfficeIMO.Word.WordParagraph

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

Parameters

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

Outputs

OfficeIMO.Word.WordParagraph

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

Parameters

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

Outputs

OfficeIMO.Word.WordParagraph

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

Parameters

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

Outputs

OfficeIMO.Word.WordParagraph