Add-OfficePdfVisual

Aliases: PdfVisual

Namespace PSWriteOffice

Aliases

PdfVisual

Inputs

OfficeIMO.Pdf.PdfDocument System.Object

Outputs

OfficeIMO.Pdf.PdfDocument

Source

Sources/PSWriteOffice/Cmdlets/Pdf/AddOfficePdfVisualCommand.cs:13 Edit on GitHub

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

Remarks

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

Examples

Authored help example

EXAMPLE 1


Add-OfficePdfVisual -Align 'Value'

EXAMPLE 2


Add-OfficePdfVisual -Document 'Value'

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-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

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Horizontal alignment in PDF flow.; Possible values: Left, Center, Right, Justify
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.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated PDF document.
PointsPerPixel Double optionalposition: namedpipeline: False: Conversion factor from ChartForgeX pixels to Office points.
SpacingAfter Double optionalposition: namedpipeline: False: Spacing after the visual in points.
SpacingBefore Double optionalposition: namedpipeline: False: Spacing before the visual in 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.

Outputs

OfficeIMO.Pdf.PdfDocument

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

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Horizontal alignment in PDF flow.; Possible values: Left, Center, Right, Justify
AlternativeText String optionalposition: namedpipeline: False: Optional accessible description for an SVG file input.
Document PdfDocument requiredposition: namedpipeline: True (ByValue): PDF document to update outside the DSL context.
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.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated PDF document.
PointsPerPixel Double optionalposition: namedpipeline: False: Conversion factor from ChartForgeX pixels to Office points.
SpacingAfter Double optionalposition: namedpipeline: False: Spacing after the visual in points.
SpacingBefore Double optionalposition: namedpipeline: False: Spacing before the visual in 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.

Outputs

OfficeIMO.Pdf.PdfDocument

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

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Horizontal alignment in PDF flow.; Possible values: Left, Center, Right, Justify
AlternativeText String optionalposition: namedpipeline: False: Optional accessible description for an SVG file input.
Document PdfDocument requiredposition: namedpipeline: True (ByValue): PDF document to update outside the DSL context.
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.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated PDF document.
PointsPerPixel Double optionalposition: namedpipeline: False: Conversion factor from ChartForgeX pixels to Office points.
SpacingAfter Double optionalposition: namedpipeline: False: Spacing after the visual in points.
SpacingBefore Double optionalposition: namedpipeline: False: Spacing before the visual in 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.

Outputs

OfficeIMO.Pdf.PdfDocument