API Reference

Cmdlet

Add-OfficeVisioConnector

Aliases: VisioConnector
Namespace PSWriteOffice
Aliases
VisioConnector
Inputs
OfficeIMO.Visio.VisioPage
Outputs
OfficeIMO.Visio.VisioConnector

Adds a connector between two Visio shapes.

Remarks

Adds a connector between two Visio shapes.

Examples

Authored help example

Connect two keyed shapes.

PS>


New-OfficeVisio -Path .\Flow.vsdx {
                VisioRectangle -Key source -Text 'Source' -X 1 -Y 4
                VisioRectangle -Key target -Text 'Target' -X 4 -Y 4
                VisioConnector -From source -To target -Kind RightAngle -EndArrow Triangle -Label 'sync'
            }
        

Adds a routed connector between shapes registered in the current DSL scope.

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-OfficeVisioConnector [-BeginArrow <Nullable`1>] [-EndArrow <Nullable`1>] -From <String> [-FromSide <Auto|Left|Right|Bottom|Top>] [-Kind <Straight|RightAngle|Curved|Dynamic>] [-Label <String>] [-LineColor <String>] [-LinePattern <Nullable`1>] [-LineWeight <Nullable`1>] [-Page <VisioPage>] -To <String> [-ToSide <Auto|Left|Right|Bottom|Top>] [<CommonParameters>]
#
Parameter set: ByKey

Parameters

BeginArrow Nullable`1 optionalposition: namedpipeline: False
Begin arrow style.
EndArrow Nullable`1 optionalposition: namedpipeline: False
End arrow style.
From String requiredposition: namedpipeline: False
Source shape key, id, or name.
FromSide VisioSide optionalposition: namedpipeline: Falsevalues: 5
Preferred source shape side.
Possible values: Auto, Left, Right, Bottom, Top
Kind ConnectorKind optionalposition: namedpipeline: Falsevalues: 4
Connector kind.
Possible values: Straight, RightAngle, Curved, Dynamic
Label String optionalposition: namedpipeline: False
Connector label.
LineColor String optionalposition: namedpipeline: False
Line color name or hex value.
LinePattern Nullable`1 optionalposition: namedpipeline: False
Line pattern.
LineWeight Nullable`1 optionalposition: namedpipeline: False
Line weight.
Page VisioPage optionalposition: namedpipeline: True (ByValue)
Target page. Optional inside VisioPage or New-OfficeVisio.
To String requiredposition: namedpipeline: False
Target shape key, id, or name.
ToSide VisioSide optionalposition: namedpipeline: Falsevalues: 5
Preferred target shape side.
Possible values: Auto, Left, Right, Bottom, Top

Outputs

OfficeIMO.Visio.VisioConnector

Add-OfficeVisioConnector [-BeginArrow <Nullable`1>] [-EndArrow <Nullable`1>] -FromShape <VisioShape> [-FromSide <Auto|Left|Right|Bottom|Top>] [-Kind <Straight|RightAngle|Curved|Dynamic>] [-Label <String>] [-LineColor <String>] [-LinePattern <Nullable`1>] [-LineWeight <Nullable`1>] [-Page <VisioPage>] -ToShape <VisioShape> [-ToSide <Auto|Left|Right|Bottom|Top>] [<CommonParameters>]
#
Parameter set: ByShape

Parameters

BeginArrow Nullable`1 optionalposition: namedpipeline: False
Begin arrow style.
EndArrow Nullable`1 optionalposition: namedpipeline: False
End arrow style.
FromShape VisioShape requiredposition: namedpipeline: False
Source shape object.
FromSide VisioSide optionalposition: namedpipeline: Falsevalues: 5
Preferred source shape side.
Possible values: Auto, Left, Right, Bottom, Top
Kind ConnectorKind optionalposition: namedpipeline: Falsevalues: 4
Connector kind.
Possible values: Straight, RightAngle, Curved, Dynamic
Label String optionalposition: namedpipeline: False
Connector label.
LineColor String optionalposition: namedpipeline: False
Line color name or hex value.
LinePattern Nullable`1 optionalposition: namedpipeline: False
Line pattern.
LineWeight Nullable`1 optionalposition: namedpipeline: False
Line weight.
Page VisioPage optionalposition: namedpipeline: True (ByValue)
Target page. Optional inside VisioPage or New-OfficeVisio.
ToShape VisioShape requiredposition: namedpipeline: False
Target shape object.
ToSide VisioSide optionalposition: namedpipeline: Falsevalues: 5
Preferred target shape side.
Possible values: Auto, Left, Right, Bottom, Top

Outputs

OfficeIMO.Visio.VisioConnector