Cmdlet

Add-OfficePdfVisual

Aliases: PdfVisual

Module: PSWriteOffice
Aliases: PdfVisual
Inputs: OfficeIMO.Pdf.PdfDocument System.Object
Outputs: OfficeIMO.Pdf.PdfDocument
Source: AddOfficePdfVisualCommand.cs:13 Edit on GitHub

Adds a ChartForgeX artifact, portable SVG, or converted Office visual to PDF flow content.

Syntax

Add-OfficePdfVisual
[-Align <Left|Center|Right|Justify>]
[-AlternativeText <String>]
[-Height <Double>]
[-Id <String>]
[-InputObject] <Object>
[-MaximumSvgElements <Int32>]
[-MaximumSvgViewportDimension <Double>]
[-MaximumSvgViewportPixels <Double>]
[-PassThru]
[-PointsPerPixel <Double>]
[-SpacingAfter <Double>]
[-SpacingBefore <Double>]
[-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>]
[-Title <String>]
[-Width <Double>]
[<CommonParameters>]

Parameter set: Context

Add-OfficePdfVisual
[-Align <Left|Center|Right|Justify>]
[-AlternativeText <String>]
-Document <PdfDocument>
[-Height <Double>]
[-Id <String>]
[-InputObject] <Object>
[-MaximumSvgElements <Int32>]
[-MaximumSvgViewportDimension <Double>]
[-MaximumSvgViewportPixels <Double>]
[-PassThru]
[-PointsPerPixel <Double>]
[-SpacingAfter <Double>]
[-SpacingBefore <Double>]
[-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>]
[-Title <String>]
[-Width <Double>]
[<CommonParameters>]

Parameter set: Document

Add-OfficePdfVisual
[-Align <Left|Center|Right|Justify>]
[-AlternativeText <String>]
-Document <PdfDocument>
[-Height <Double>]
[-Id <String>]
[-InputObject] <Object>
[-MaximumSvgElements <Int32>]
[-MaximumSvgViewportDimension <Double>]
[-MaximumSvgViewportPixels <Double>]
[-PassThru]
[-PointsPerPixel <Double>]
[-SpacingAfter <Double>]
[-SpacingBefore <Double>]
[-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>]
[-Title <String>]
[-Width <Double>]
[<CommonParameters>]

Parameter set: PipelineDocument

Examples

Example 1

Add-OfficePdfVisual -InputObject 'Value'

Example 2

Add-OfficePdfVisual -InputObject 'Value' -Document 'Value'

Parameters

-Align PdfAlign optional: Horizontal alignment in PDF flow.; Possible values: Left, Center, Right, Justify
-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.
-PassThru SwitchParameter optional: Emit the updated PDF document.
-PointsPerPixel Double optional: Conversion factor from ChartForgeX pixels to Office points.
-SpacingAfter Double optional: Spacing after the visual in points.
-SpacingBefore Double optional: Spacing before the visual in 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.
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document, PipelineDocument: PDF document to update outside the DSL context.

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.