Cmdlet

Add-OfficeWordVisual

Aliases: WordVisual

Module: PSWriteOffice
Aliases: WordVisual
Inputs: System.Object
Outputs: OfficeIMO.Word.WordImage
Source: AddOfficeWordVisualCommand.cs:19 Edit on GitHub

Adds a ChartForgeX artifact, portable SVG, or converted Office visual to Word.

Syntax

Add-OfficeWordVisual
[-AlternativeText <String>]
[-Height <Double>]
[-Id <String>]
[-InputObject] <Object>
[-MaximumSvgElements <Int32>]
[-MaximumSvgViewportDimension <Double>]
[-MaximumSvgViewportPixels <Double>]
[-Paragraph <WordParagraph>]
[-PassThru]
[-PointsPerPixel <Double>]
[-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>]
[-Title <String>]
[-Width <Double>]
[-Wrap <WordImageTextWrapping>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Pipe an ImagePlayground artifact into a Word paragraph.

WordParagraph { $artifact | Add-OfficeWordVisual -Width 420 }

Embeds the selected SVG or PNG payload with the artifact's accessible description.

Parameters

-AlternativeText String optional: Optional accessible description for an SVG file input.
-Height Double optional: Optional output height in Office points.
-Id String optional: Optional stable identifier for an SVG file input.
-InputObject Object requiredposition: 0pipeline: True (ByValue): ChartForgeX VisualArtifact, OfficeVisualSource, OfficeVisualConversionResult, or SVG file path.
-MaximumSvgElements Int32 optional: Optional OfficeIMO SVG import element limit.
-MaximumSvgViewportDimension Double optional: Optional maximum SVG viewport width or height. Increase the safe default only for trusted input.
-MaximumSvgViewportPixels Double optional: Optional maximum SVG viewport area in pixels. Increase the safe default only for trusted input.
-Paragraph WordParagraph optional: Target paragraph. Inside the Word DSL, the current paragraph is used by default.
-PassThru SwitchParameter optional: Emit the image added to the paragraph.
-PointsPerPixel Double optional: Conversion factor from ChartForgeX pixels to Office points.
-SvgPolicy OfficeVisualSvgPolicy optional: SVG fidelity policy used by OfficeIMO.ChartForgeX.; Possible values: PreserveVector, RasterizeWhenNeeded, RequireVector
-Title String optional: Optional title for an SVG file input.
-Width Double optional: Optional output width in Office points.
-Wrap WordImageTextWrapping optional: Word text-wrapping behavior.; Possible values: InLineWithText, Square, Tight, Through, TopAndBottom, BehindText, InFrontOfText

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.