ConvertTo-OfficeVisioVisual

Namespace PSWriteOffice

Inputs

System.Object

Outputs

OfficeIMO.ChartForgeX.OfficeVisioVisualConversionResult

Source

Sources/PSWriteOffice/Cmdlets/Visio/ConvertToOfficeVisioVisualCommand.cs:17 Edit on GitHub

Converts CFX semantic visual-artifact input into a native editable OfficeIMO.Visio document.

Remarks

Converts CFX semantic visual-artifact input into a native editable OfficeIMO.Visio document.

Examples

Authored help example

Convert an ImagePlayground topology into editable Visio objects.

PS>


$visio = $topology | ConvertTo-ImageVisualArtifact | ConvertTo-OfficeVisioVisual
            $visio.Document | Save-OfficeVisio -Path .\Topology.vsdx

Consumes the portable CFX semantic payload and returns the document, page, and fidelity report.

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

ConvertTo-OfficeVisioVisual -InputObject <Object> [-NoGroups] [-NoHyperlinks] [-NoShapeData] [-NoTitle] [-PageName <String>] [-PixelsPerInch <Double>] [-UseNaturalPageSize] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

InputObject Object requiredposition: 0pipeline: True (ByValue): Typed CFX artifact, semantic envelope/JSON, ImagePlayground portable artifact, or prior conversion result.
NoGroups SwitchParameter optionalposition: namedpipeline: False: Do not create native Visio containers for CFX groups or lanes.
NoHyperlinks SwitchParameter optionalposition: namedpipeline: False: Do not copy safe CFX links onto native Visio shapes and connectors.
NoShapeData SwitchParameter optionalposition: namedpipeline: False: Do not copy CFX metadata, ports, and details into Visio Shape Data.
NoTitle SwitchParameter optionalposition: namedpipeline: False: Do not add the artifact title as an editable Visio title.
PageName String optionalposition: namedpipeline: False: Name of the generated Visio page.
PixelsPerInch Double optionalposition: namedpipeline: False: Pixel density used with -UseNaturalPageSize.
UseNaturalPageSize SwitchParameter optionalposition: namedpipeline: False: Use the CFX natural pixel size as the minimum Visio page size.

Outputs

OfficeIMO.ChartForgeX.OfficeVisioVisualConversionResult