Cmdlet

New-OfficeVisioImageOptions

Module: PSWriteOffice
Inputs: None
Outputs: OfficeIMO.Visio.VisioImageExportOptions
Source: NewOfficeVisioImageOptionsCommand.cs:16 Edit on GitHub

Creates discoverable page and rendering settings for Export-OfficeVisioImage.

Syntax

New-OfficeVisioImageOptions
[-BackgroundColor <String>]
[-IncludeSvgXmlDeclaration]
[-MaximumDegreeOfParallelism <Int32>]
[-MaximumOutputCount <Int32>]
[-MaximumOutputHeight <Int32>]
[-MaximumOutputWidth <Int32>]
[-MaximumRasterPixels <Int64>]
[-MaximumTotalEncodedBytes <Int64>]
[-MaximumTotalRasterPixels <Int64>]
[-PageCount <Int32>]
[-PageIndex <Int32>]
[-RasterOverflowBehavior <ReduceScale|Throw>]
[-RenderConnectorLabels]
[-RenderStencilArtwork]
[-RenderText]
[-RenderTimeoutSeconds <Double>]
[-ResolveConnectorLabelOverlaps]
[-Scale <Double>]
[-Supersampling <Int32>]
[-TargetDpi <Double>]
[-TextShapingLanguage <String>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Render the first Visio page with text and connector labels.

$options = New-OfficeVisioImageOptions -PageIndex 0 -PageCount 1 -RenderText -RenderConnectorLabels
Export-OfficeVisioImage -Path .\Diagram.vsdx -OutputPath .\Preview -Format Svg -Options $options

Parameters

-BackgroundColor String optional: Background color name or hex value.
-IncludeSvgXmlDeclaration SwitchParameter optional: Include an XML declaration in SVG output.
-MaximumDegreeOfParallelism Int32 optional: Maximum independent renders processed concurrently.
-MaximumOutputCount Int32 optional: Maximum images accepted from one batch export.
-MaximumOutputHeight Int32 optional: Maximum output height in pixels.
-MaximumOutputWidth Int32 optional: Maximum output width in pixels.
-MaximumRasterPixels Int64 optional: Maximum pixels allocated for one raster image.
-MaximumTotalEncodedBytes Int64 optional: Maximum aggregate encoded bytes accepted from one batch.
-MaximumTotalRasterPixels Int64 optional: Maximum aggregate raster pixels accepted from one batch.
-PageCount Int32 optional: Maximum pages exported.
-PageIndex Int32 optional: Zero-based first page index.
-RasterOverflowBehavior OfficeRasterOverflowBehavior optional: Reduce or reject oversized raster output.; Possible values: ReduceScale, Throw
-RenderConnectorLabels SwitchParameter optional: Render connector labels.
-RenderStencilArtwork SwitchParameter optional: Render supported stencil artwork.
-RenderText SwitchParameter optional: Render page text.
-RenderTimeoutSeconds Double optional: Maximum seconds allowed for one render.
-ResolveConnectorLabelOverlaps SwitchParameter optional: Resolve connector-label overlaps.
-Scale Double optional: Output scale multiplier.
-Supersampling Int32 optional: Raster supersampling factor.
-TargetDpi Double optional: Target output density in dots per inch.
-TextShapingLanguage String optional: BCP 47 language hint for text shaping.

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.