Set-OfficeWordImage

Aliases: WordImageStyle

Namespace PSWriteOffice

Aliases

WordImageStyle

Inputs

OfficeIMO.Word.WordImage

Outputs

OfficeIMO.Word.WordImage

Source

Sources/PSWriteOffice/Cmdlets/Word/SetOfficeWordImageCommand.cs:17 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 <Nullable`1>] [-CropLeft <Nullable`1>] [-CropRight <Nullable`1>] [-CropTop <Nullable`1>] [-Description <String>] [-Height <Nullable`1>] [-Hidden <Nullable`1>] [-HorizontalFlip <Nullable`1>] -Image <WordImage> [-Opacity <Nullable`1>] [-PassThru] [-Rotation <Nullable`1>] [-Title <String>] [-VerticalFlip <Nullable`1>] [-Width <Nullable`1>] [-Wrap <Nullable`1>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

CropBottom Nullable`1 optionalposition: namedpipeline: False: Bottom crop value.
CropLeft Nullable`1 optionalposition: namedpipeline: False: Left crop value.
CropRight Nullable`1 optionalposition: namedpipeline: False: Right crop value.
CropTop Nullable`1 optionalposition: namedpipeline: False: Top crop value.
Description String optionalposition: namedpipeline: False: Image alternate text metadata.
Height Nullable`1 optionalposition: namedpipeline: False: Image height in points.
Hidden Nullable`1 optionalposition: namedpipeline: False: Whether the image is hidden.
HorizontalFlip Nullable`1 optionalposition: namedpipeline: False: Horizontally flip the image.
Image WordImage requiredposition: 0pipeline: True (ByValue): Image to update.
Opacity Nullable`1 optionalposition: namedpipeline: False: Fixed opacity percentage.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated image.
Rotation Nullable`1 optionalposition: namedpipeline: False: Image rotation in degrees.
Title String optionalposition: namedpipeline: False: Image title metadata.
VerticalFlip Nullable`1 optionalposition: namedpipeline: False: Vertically flip the image.
Width Nullable`1 optionalposition: namedpipeline: False: Image width in points.
Wrap Nullable`1 optionalposition: namedpipeline: False: Text wrapping mode.

Outputs

OfficeIMO.Word.WordImage