Add-OfficeWordImage

Aliases: WordImage

Namespace PSWriteOffice

Aliases

WordImage

Inputs

None

Source

Sources/PSWriteOffice/Cmdlets/Word/AddOfficeWordImageCommand.cs:18 Edit on GitHub

Inserts an image into the current paragraph.

Remarks

Supports width/height overrides and wrapping options using the alias-friendly DSL.

Examples

Authored help example

Add a logo.

PS>


Add-OfficeWordParagraph { Add-OfficeWordImage -Path .\logo.png -Width 96 -Height 32 }

Embeds logo.png at the specified size.

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

Add-OfficeWordImage [-Description <String>] [-Height <Double>] [-PassThru] -Path <String> [-Width <Double>] [-Wrap <InLineWithText>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Description String optionalposition: namedpipeline: False: Optional description/alt text.
Height Double optionalposition: namedpipeline: False: Height in points.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the created WordImage.
Path String requiredposition: 0pipeline: False: Path to the image file.
Width Double optionalposition: namedpipeline: False: Width in points.
Wrap WordImageTextWrapping optionalposition: namedpipeline: Falsevalues: 7: Wrap mode for the image.; Possible values: InLineWithText, Square, Tight, Through, TopAndBottom, BehindText, InFrontOfText