Cmdlet

Add-OfficeWordImage

Aliases: WordImage

Module: PSWriteOffice
Aliases: WordImage
Inputs: OfficeIMO.Word.WordParagraph System.Object
Outputs: OfficeIMO.Word.WordImage
Source: AddOfficeWordImageCommand.cs:21 Edit on GitHub

Embeds an image file, SVG or reusable visual in a Word paragraph.

Syntax

Add-OfficeWordImage
[-Description <String>]
[-Height <OfficeLength>]
[-Paragraph <WordParagraph>]
[-PassThru]
[-Path] <String>
[-Title <String>]
[-Width <OfficeLength>]
[-Wrap <WordImageTextWrapping>]
[<CommonParameters>]

Parameter set: Path

Add-OfficeWordImage
[-Description <String>]
[-Height <OfficeLength>]
[-Id <String>]
-InputObject <Object>
[-MaximumSvgElements <Int32>]
[-MaximumSvgViewportDimension <Double>]
[-MaximumSvgViewportPixelCount <Int64>]
[-Paragraph <WordParagraph>]
[-PassThru]
[-PointsPerPixel <Double>]
[-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>]
[-Title <String>]
[-Width <OfficeLength>]
[-Wrap <WordImageTextWrapping>]
[<CommonParameters>]

Parameter set: Visual

Description

Numbers mean points; unit suffixes such as 4cm are accepted. A prepared visual is reused without changing its payload or metadata. One dimension preserves proportions; two dimensions set the displayed frame.

Examples

Insert a local logo.

WordParagraph { WordImage -Path ./logo.png -Width 4cm -Description 'Contoso' }

Place a reusable visual in an existing paragraph.

$visual | WordImage -Paragraph $paragraph -Width 12cm -Title 'Availability' -PassThru

Parameters

-Description String optional: Accessible image description; omitted visual descriptions are retained.
-Height OfficeLength optional: Optional output height; numbers mean points and unit suffixes are accepted.
-Paragraph WordParagraph optionalpipeline: True (ByValue): Target paragraph; the current DSL paragraph is used when omitted.
-PassThru SwitchParameter optional: Return the native editable WordImage.
-Path String requiredposition: 0sets: Path: Literal local image path.
-Title String optional: Optional title for an SVG file input.
-Width OfficeLength optional: Optional output width; numbers mean points and unit suffixes are accepted.
-Wrap WordImageTextWrapping optional: Text wrapping around the embedded image.; Possible values: InLineWithText, Square, Tight, Through, TopAndBottom, BehindText, InFrontOfText
-Id String optionalsets: Visual: Optional stable identifier for an SVG file input.
-InputObject Object requiredpipeline: True (ByValue)sets: Visual: ChartForgeX artifact, OfficeVisualSource, prepared visual or SVG path.
-MaximumSvgElements Int32 optionalsets: Visual: Optional OfficeIMO SVG import element limit.
-MaximumSvgViewportDimension Double optionalsets: Visual: Optional maximum SVG viewport width or height. Increase the safe default only for trusted input.
-MaximumSvgViewportPixelCount Int64 optionalsets: Visual: Optional maximum SVG viewport area in pixels. Increase the safe default only for trusted input.
-PointsPerPixel Double optionalsets: Visual: Conversion factor from ChartForgeX pixels to Office points.
-SvgPolicy OfficeVisualSvgPolicy optionalsets: Visual: SVG fidelity policy used by OfficeIMO.ChartForgeX.; Possible values: PreserveVector, RasterizeWhenNeeded, RequireVector

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.