Set-OfficeWordImage

Aliases: WordImageStyle

Namespace PSWriteOffice

Aliases

WordImageStyle

Inputs

OfficeIMO.Word.WordImage

Outputs

OfficeIMO.Word.WordImage

Source

Sources/PSWriteOffice/Cmdlets/Word/SetOfficeWordImageCommand.cs:20 Edit on GitHub

Updates OfficeIMO Word image sizing, wrapping, crop, and metadata.

Remarks

Updates OfficeIMO Word image sizing, wrapping, crop, and metadata.

Examples

Authored help example

Resize and describe all report images.

PS>


$doc = Get-OfficeWord -Path .\Report.docx
            $doc |
                Get-OfficeWordImage |
                Set-OfficeWordImage -Width 320 -Wrap Square -Title 'Report image' -Description 'Image used in the report'
            $doc | Save-OfficeWord -Path .\Report-Images.docx

Gets OfficeIMO image objects from an open document, applies thin image metadata and layout updates, and saves the document.

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

Set-OfficeWordImage [-CropBottom <Int32>] [-CropLeft <Int32>] [-CropRight <Int32>] [-CropTop <Int32>] [-Description <String>] [-Height <Double>] [-Hidden <Boolean>] [-HorizontalFlip <Boolean>] -Image <WordImage> [-Opacity <Int32>] [-PassThru] [-Rotation <Int32>] [-Title <String>] [-VerticalFlip <Boolean>] [-Width <Double>] [-Wrap <InLineWithText>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

CropBottom Int32 optionalposition: namedpipeline: False: Bottom crop value.
CropLeft Int32 optionalposition: namedpipeline: False: Left crop value.
CropRight Int32 optionalposition: namedpipeline: False: Right crop value.
CropTop Int32 optionalposition: namedpipeline: False: Top crop value.
Description String optionalposition: namedpipeline: False: Image alternate text metadata.
Height Double optionalposition: namedpipeline: False: Image height in points.
Hidden Boolean optionalposition: namedpipeline: False: Whether the image is hidden.
HorizontalFlip Boolean optionalposition: namedpipeline: False: Horizontally flip the image.
Image WordImage requiredposition: 0pipeline: True (ByValue): Image to update.
Opacity Int32 optionalposition: namedpipeline: False: Fixed opacity percentage.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated image.
Rotation Int32 optionalposition: namedpipeline: False: Image rotation in degrees.
Title String optionalposition: namedpipeline: False: Image title metadata.
VerticalFlip Boolean optionalposition: namedpipeline: False: Vertically flip the image.
Width Double optionalposition: namedpipeline: False: Image width in points.
Wrap WordImageTextWrapping optionalposition: namedpipeline: Falsevalues: 7: Text wrapping mode.; Possible values: InLineWithText, Square, Tight, Through, TopAndBottom, BehindText, InFrontOfText

Outputs

OfficeIMO.Word.WordImage