Add-OfficeWordVisual

Aliases: WordVisual

Namespace PSWriteOffice

Aliases

WordVisual

Inputs

System.Object

Outputs

OfficeIMO.Word.WordImage

Source

Sources/PSWriteOffice/Cmdlets/Word/AddOfficeWordVisualCommand.cs:19 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Pipe an ImagePlayground artifact into a Word paragraph.

PS>


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

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

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-OfficeWordVisual [-AlternativeText <String>] [-Height <Double>] [-Id <String>] -InputObject <Object> [-MaximumSvgElements <Int32>] [-MaximumSvgViewportDimension <Double>] [-MaximumSvgViewportPixels <Double>] [-Paragraph <WordParagraph>] [-PointsPerPixel <Double>] [-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>] [-Title <String>] [-Width <Double>] [-Wrap <InLineWithText>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

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

Outputs

OfficeIMO.Word.WordImage