Cmdlet

Add-OfficeVisioConnector

Aliases: VisioConnector

Module: PSWriteOffice
Aliases: VisioConnector
Inputs: OfficeIMO.Visio.VisioPage
Outputs: OfficeIMO.Visio.VisioConnector
Source: AddOfficeVisioConnectorCommand.cs:23 Edit on GitHub

Adds a connector between two Visio shapes.

Syntax

Add-OfficeVisioConnector
[-BeginArrow <Arrow|Triangle>]
[-EndArrow <Arrow|Triangle>]
-From <String>
[-FromSide <Auto|Left|Right|Bottom|Top>]
[-Kind <Straight|RightAngle|Curved|Dynamic>]
[-Label <String>]
[-LineColor <String>]
[-LinePattern <Int32>]
[-LineWeight <Double>]
[-Page <VisioPage>]
[-PassThru]
-To <String>
[-ToSide <Auto|Left|Right|Bottom|Top>]
[<CommonParameters>]

Parameter set: ByKey

Add-OfficeVisioConnector
[-BeginArrow <Arrow|Triangle>]
[-EndArrow <Arrow|Triangle>]
-FromShape <VisioShape>
[-FromSide <Auto|Left|Right|Bottom|Top>]
[-Kind <Straight|RightAngle|Curved|Dynamic>]
[-Label <String>]
[-LineColor <String>]
[-LinePattern <Int32>]
[-LineWeight <Double>]
[-Page <VisioPage>]
[-PassThru]
-ToShape <VisioShape>
[-ToSide <Auto|Left|Right|Bottom|Top>]
[<CommonParameters>]

Parameter set: ByShape

Examples

Connect two keyed shapes.

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.

Parameters

-BeginArrow EndArrow optional: Begin arrow style.; Possible values: Arrow, Triangle
-EndArrow EndArrow optional: End arrow style.; Possible values: Arrow, Triangle
-From String requiredsets: ByKey: Source shape key, id, or name.
-FromSide VisioSide optional: Preferred source shape side.; Possible values: Auto, Left, Right, Bottom, Top
-Kind ConnectorKind optional: Connector kind.; Possible values: Straight, RightAngle, Curved, Dynamic
-Label String optional: Connector label.
-LineColor String optional: Line color name or hex value.
-LinePattern Int32 optional: Native Visio line-pattern index: 0 hides the line, 1 is solid, and 2 through 23 select built-in patterns.
-LineWeight Double optional: Line weight.
-Page VisioPage optionalpipeline: True (ByValue): Target page. Optional inside VisioPage or OfficeVisio.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-To String requiredsets: ByKey: Target shape key, id, or name.
-ToSide VisioSide optional: Preferred target shape side.; Possible values: Auto, Left, Right, Bottom, Top
-FromShape VisioShape requiredsets: ByShape: Source shape object.
-ToShape VisioShape requiredsets: ByShape: Target shape object.

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.