API Reference

Cmdlet

New-OfficeVisioImageOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Visio.VisioImageExportOptions

Creates discoverable page and rendering settings for Export-OfficeVisioImage.

Remarks

Creates discoverable page and rendering settings for Export-OfficeVisioImage.

Examples

Authored help example

Render the first Visio page with text and connector labels.

PS>


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

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

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

Parameters

BackgroundColor String optionalposition: namedpipeline: False
IncludeSvgXmlDeclaration SwitchParameter optionalposition: namedpipeline: False
Include an XML declaration in SVG output.
MaximumDegreeOfParallelism Int32 optionalposition: namedpipeline: False
MaximumOutputCount Int32 optionalposition: namedpipeline: False
MaximumOutputHeight Int32 optionalposition: namedpipeline: False
MaximumOutputWidth Int32 optionalposition: namedpipeline: False
MaximumRasterPixels Int64 optionalposition: namedpipeline: False
MaximumTotalEncodedBytes Int64 optionalposition: namedpipeline: False
MaximumTotalRasterPixels Int64 optionalposition: namedpipeline: False
PageCount Int32 optionalposition: namedpipeline: False
Maximum pages exported.
PageIndex Int32 optionalposition: namedpipeline: False
Zero-based first page index.
RasterOverflowBehavior OfficeRasterOverflowBehavior optionalposition: namedpipeline: Falsevalues: 2
Possible values: ReduceScale, Throw
RenderConnectorLabels SwitchParameter optionalposition: namedpipeline: False
Render connector labels.
RenderStencilArtwork SwitchParameter optionalposition: namedpipeline: False
Render supported stencil artwork.
RenderText SwitchParameter optionalposition: namedpipeline: False
Render page text.
RenderTimeoutSeconds Double optionalposition: namedpipeline: False
ResolveConnectorLabelOverlaps SwitchParameter optionalposition: namedpipeline: False
Resolve connector-label overlaps.
Scale Double optionalposition: namedpipeline: False
Supersampling Int32 optionalposition: namedpipeline: False
Raster supersampling factor.
TargetDpi Double optionalposition: namedpipeline: False
TextShapingLanguage String optionalposition: namedpipeline: False

Outputs

OfficeIMO.Visio.VisioImageExportOptions