Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

New-OfficeVisioImageOptions

Module
PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Visio.VisioImageExportOptions

Creates discoverable page and rendering settings for Export-OfficeVisioImage.

Syntax

New-OfficeVisioImageOptions
[-Font <String>]
[-FontCollectionIndex <Int32>]
[-FontPath <String>]
[-IncludeSvgXmlDeclaration]
[-MaximumDegreeOfParallelism <Int32>]
[-MaximumOutputCount <Int32>]
[-MaximumOutputHeight <Int32>]
[-MaximumOutputWidth <Int32>]
[-MaximumRasterPixelCount <Int64>]
[-MaximumTotalEncodedBytes <Int64>]
[-MaximumTotalRasterPixelCount <Int64>]
[-NoConnectorLabelOverlapResolution]
[-NoConnectorLabels]
[-NoStencilArtwork]
[-NoText]
[-RasterOverflowBehavior <ReduceScale|Throw>]
[-RenderTimeoutSeconds <Double>]
[-Supersampling <Int32>]
[-TextShapingLanguage <String>]
[<CommonParameters>]
#
Parameter set: Options

Examples

Render a Visio page with a selected font.

$options = New-OfficeVisioImageOptions -Font Arial -NoConnectorLabels
Export-OfficeDocumentImage -Path ./Diagram.vsdx -Page 1 -Format Svg -OutputDirectory ./Preview -Options $options

Parameters

-Font String optional
Font face name used for text rendering.
-FontCollectionIndex Int32 optional
Face index within a font collection.
-FontPath String optional
Literal font file used for text rendering.
-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.
-MaximumRasterPixelCount Int64 optional
Maximum pixels allocated for one raster image.
-MaximumTotalEncodedBytes Int64 optional
Maximum aggregate encoded bytes accepted from one batch.
-MaximumTotalRasterPixelCount Int64 optional
Maximum aggregate raster pixels accepted from one batch.
-NoConnectorLabelOverlapResolution SwitchParameter optional
Resolve connector-label overlaps.
-NoConnectorLabels SwitchParameter optional
Render connector labels.
-NoStencilArtwork SwitchParameter optional
Render supported stencil artwork.
-NoText SwitchParameter optional
Render page text.
-RasterOverflowBehavior OfficeRasterOverflowBehavior optional
Reduce or reject oversized raster output.
Possible values: ReduceScale, Throw
-RenderTimeoutSeconds Double optional
Maximum seconds allowed for one render.
-Supersampling Int32 optional
Raster supersampling factor.
-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.