Get Started

API Reference

Cmdlet

Get-OfficeWordShape

Aliases: WordShapes
Namespace PSWriteOffice
Aliases
WordShapes
Inputs
OfficeIMO.Word.WordDocument OfficeIMO.Word.WordSection OfficeIMO.Word.WordParagraph
Outputs
OfficeIMO.Word.WordShape
Source
Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordShapeCommand.cs:19 Edit on GitHub

Gets shapes from a Word document, section, or paragraph.

Remarks

Gets shapes from a Word document, section, or paragraph.

Examples

Authored help example

List shapes and metadata.

PS>


$shapes = Get-OfficeWordShape -Path .\Report.docx
            $shapes |
                Select-Object -Property Title, Description, Width, Height, FillColorHex |
                Format-Table -AutoSize

Reads OfficeIMO Word shapes from the document so styling and alternate text can be audited.

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-OfficeWordShape -InputPath <String> [<CommonParameters>]
#
Parameter set: Path

Parameters

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

Outputs

OfficeIMO.Word.WordShape

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

Parameters

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

Outputs

OfficeIMO.Word.WordShape

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

Parameters

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

Outputs

OfficeIMO.Word.WordShape

Get-OfficeWordShape -Paragraph <WordParagraph> [<CommonParameters>]
#
Parameter set: Paragraph

Parameters

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

Outputs

OfficeIMO.Word.WordShape