Cmdlet

Add-OfficeWordShape

Aliases: WordShape

Module PSWriteOffice

Aliases

WordShape

Inputs

None

Outputs

OfficeIMO.Word.WordShape

Source

AddOfficeWordShapeCommand.cs:30 Edit on GitHub

Adds a basic OfficeIMO Word shape to the current paragraph.

Syntax

Add-OfficeWordShape [-Description <String>] [-FillColor <String>] [-Height <Double>] [-Left <Double>] [-PassThru] [-StrokeColor <String>] [-StrokeWidth <Double>] [-Title <String>] [-Top <Double>] [-Type <WordShapeType>] [-Width <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Add a callout shape to a report section.

New-OfficeWord -Path .\StatusReport.docx {
    Add-OfficeWordParagraph -Text 'Release readiness'
    Add-OfficeWordShape -Type Rectangle -Width 220 -Height 56 -FillColor '#e6fffb' -StrokeColor '#08979c' -StrokeWidth 1.5 -Title 'Status callout' -Description 'Release readiness callout'
}

Creates an OfficeIMO Word shape in the current paragraph and sets basic visual and accessibility metadata.

Add an anchored background shape.

New-OfficeWord -Path .\Appendix.docx {
    Add-OfficeWordParagraph -Text 'Appendix A'
    Add-OfficeWordShape -Type Rectangle -Width 480 -Height 36 -Left 36 -Top 72 -FillColor '#f0f5ff' -StrokeColor '#adc6ff'
}

Positions a shape with explicit offsets when the OfficeIMO anchored-shape API is desired.

Parameters

-Description String optional: Optional alternate text metadata.
-FillColor String optional: Fill color. Named colors and hexadecimal values are accepted.
-Height Double optional: Height in points.
-Left Double optional: Anchored left position in points. When omitted, the shape is inline.
-PassThru SwitchParameter optional: Emit the created shape.
-StrokeColor String optional: Stroke color. Named colors and hexadecimal values are accepted.
-StrokeWidth Double optional: Stroke width in points.
-Title String optional: Optional title metadata.
-Top Double optional: Anchored top position in points. When omitted, the shape is inline.
-Type WordShapeType optional: Shape type to add.; Possible values: Rectangle, Ellipse, Line, RoundedRectangle, Triangle, Diamond, Pentagon, Hexagon, Parallelogram, Trapezoid, Chevron, Plus, RightArrow, LeftArrow, UpArrow, DownArrow, LeftRightArrow, Star5, Heart, Cloud, Donut, Can, Cube
-Width Double optional: Width in points.

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.