API Reference

Class

VisioConnectorSelection

Edit on GitHub

Namespace OfficeIMO.Visio

Assembly OfficeIMO.Visio

Source OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:18

Implements

IReadOnlyList<VisioConnector> IReadOnlyCollection<VisioConnector> IEnumerable<VisioConnector> IEnumerable

Modifiers sealed

Attributes

DefaultMember("Item")

Editable set of Visio connectors returned by query helpers.

Inheritance

Object
VisioConnectorSelection

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Method VisioConnectorRoutingExtensions.ClearRoutes
Method VisioConnectorRoutingExtensions.PlaceLabels
Method VisioConnectorRoutingExtensions.RouteOrthogonal
Method VisioConnectorRoutingExtensions.RouteThrough
Extension method VisioConnectorSelection.ApplyStyle
Extension method VisioConnectorSelection.ApplyTextStyle
Extension method VisioConnectorSelection.ClearRoutes
Extension method VisioConnectorSelection.PlaceLabels
Extension method VisioConnectorSelection.ResizeLabelsToText
Extension method VisioConnectorSelection.RouteOrthogonal
Extension method VisioConnectorSelection.RouteThrough
Method VisioConnectorSelection.BeginArrow
Method VisioConnectorSelection.ClearProtection
Method VisioConnectorSelection.EndArrow
Method VisioConnectorSelection.Hyperlink
Method VisioConnectorSelection.Kind
Method VisioConnectorSelection.Label
Method VisioConnectorSelection.LabelPosition
Method VisioConnectorSelection.LineColor
Method VisioConnectorSelection.LinePattern
Method VisioConnectorSelection.LineWeight
Method VisioConnectorSelection.LockEndpoints
Method VisioConnectorSelection.Protect
Method VisioConnectorSelection.Stroke
Method VisioConnectorSelection.Style
Method VisioLayoutExtensions.ResizeLabelsToText
Extension method VisioPage.SelectConnectedConnectors
Extension method VisioPage.SelectConnectors
Extension method VisioPage.SelectConnectorsInLayer
Extension method VisioPage.SelectConnectorsWithHyperlink
Extension method VisioPage.SelectConnectorsWithHyperlinks
Extension method VisioPage.SelectConnectorsWithProtection
Extension method VisioPage.SelectConnectorsWithProtection
Extension method VisioPage.SelectIncomingConnectors
Extension method VisioPage.SelectOutgoingConnectors
Method VisioPageQueryExtensions.SelectConnectedConnectors
Method VisioPageQueryExtensions.SelectConnectors
Method VisioPageQueryExtensions.SelectConnectorsInLayer
Method VisioPageQueryExtensions.SelectConnectorsWithHyperlink
Method VisioPageQueryExtensions.SelectConnectorsWithHyperlinks
Method VisioPageQueryExtensions.SelectConnectorsWithProtection
Method VisioPageQueryExtensions.SelectConnectorsWithProtection
Method VisioPageQueryExtensions.SelectIncomingConnectors
Method VisioPageQueryExtensions.SelectOutgoingConnectors
Method VisioStyleExtensions.ApplyStyle
Method VisioStyleExtensions.ApplyTextStyle

Accepted by parameters

Method VisioConnectorRoutingExtensions.ClearRoutes parameter selection
Method VisioConnectorRoutingExtensions.PlaceLabels parameter selection
Method VisioConnectorRoutingExtensions.RouteOrthogonal parameter selection
Method VisioConnectorRoutingExtensions.RouteThrough parameter selection
Extension method VisioConnectorSelection.ClearRoutes parameter selection
Extension method VisioConnectorSelection.PlaceLabels parameter selection
Extension method VisioConnectorSelection.ResizeLabelsToText parameter selection
Method VisioLayoutExtensions.ResizeLabelsToText parameter selection
Method VisioStyleExtensions.ApplyStyle parameter selection
Method VisioStyleExtensions.ApplyTextStyle parameter selection

Constructors

public VisioConnectorSelection(IEnumerable<VisioConnector> connectors) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:18

Initializes a new connector selection.

Parameters

connectors System.Collections.Generic.IEnumerable{OfficeIMO.Visio.VisioConnector} requiredposition: 0: Connectors included in the selection.

Methods

public VisioConnectorSelection BeginArrow(Nullable<EndArrow> arrow) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:147

Returns: VisioConnectorSelection

Sets begin arrow on every selected connector.

Parameters

arrow System.Nullable{OfficeIMO.Visio.EndArrow} requiredposition: 0: Begin arrow style.

public VisioConnectorSelection ClearProtection() #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:211

Returns: VisioConnectorSelection

Clears explicit protection settings for every selected connector.

public VisioConnectorSelection EndArrow(Nullable<EndArrow> arrow) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:159

Returns: VisioConnectorSelection

Sets end arrow on every selected connector.

Parameters

arrow System.Nullable{OfficeIMO.Visio.EndArrow} requiredposition: 0: End arrow style.

public virtual IEnumerator<VisioConnector> GetEnumerator() #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:34

Returns: IEnumerator<VisioConnector>

public VisioConnectorSelection Hyperlink(String address, String description = null, String subAddress = null) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:173

Returns: VisioConnectorSelection

Adds a hyperlink to every selected connector.

Parameters

address System.String requiredposition: 0: External hyperlink address.
description System.String = null optionalposition: 1: Optional display description.
subAddress System.String = null optionalposition: 2: Optional internal sub-address.

public VisioConnectorSelection Kind(ConnectorKind kind) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:47

Returns: VisioConnectorSelection

Sets connector kind on every selected connector.

Parameters

kind OfficeIMO.Visio.ConnectorKind requiredposition: 0: Connector kind.

public VisioConnectorSelection Label(String label) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:59

Returns: VisioConnectorSelection

Sets connector label on every selected connector.

Parameters

label System.String requiredposition: 0: Connector label.

public VisioConnectorSelection LabelPosition(Double position = 0.5, Double offsetX = 0, Double offsetY = 0, Double width = 1.25, Double height = 0.3)

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:75

Returns: VisioConnectorSelection

Places connector labels along every selected connector.

Parameters

position System.Double = 0.5 optionalposition: 0: Position along each connector path, from 0.0 to 1.0.
offsetX System.Double = 0 optionalposition: 1: Horizontal page-coordinate offset.
offsetY System.Double = 0 optionalposition: 2: Vertical page-coordinate offset.
width System.Double = 1.25 optionalposition: 3: Label text box width in page units.
height System.Double = 0.3 optionalposition: 4: Label text box height in page units.

public VisioConnectorSelection LineColor(OfficeColor color) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:111

Returns: VisioConnectorSelection

Sets line color on every selected connector.

Parameters

color OfficeIMO.Drawing.OfficeColor requiredposition: 0: Line color.

public VisioConnectorSelection LinePattern(Int32 pattern) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:135

Returns: VisioConnectorSelection

Sets line pattern on every selected connector.

Parameters

pattern System.Int32 requiredposition: 0: Line pattern index.

public VisioConnectorSelection LineWeight(Double weight) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:123

Returns: VisioConnectorSelection

Sets line weight on every selected connector.

Parameters

weight System.Double requiredposition: 0: Line weight in inches.

public VisioConnectorSelection LockEndpoints(Boolean locked = true) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:200

Returns: VisioConnectorSelection

Locks or unlocks endpoints for every selected connector.

Parameters

locked System.Boolean = true optionalposition: 0

public VisioConnectorSelection Protect(Action<VisioProtection> configure) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:185

Returns: VisioConnectorSelection

Configures protection for every selected connector.

Parameters

configure System.Action{OfficeIMO.Visio.VisioProtection} requiredposition: 0: Protection configuration delegate.

public VisioConnectorSelection Stroke(OfficeColor color, Double weight = 0.0138889, Int32 pattern = 1) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:89

Returns: VisioConnectorSelection

Sets line color, weight, and pattern on every selected connector.

Parameters

color OfficeIMO.Drawing.OfficeColor requiredposition: 0: Line color.
weight System.Double = 0.0138889 optionalposition: 1: Line weight in inches.
pattern System.Int32 = 1 optionalposition: 2: Line pattern index.

public VisioConnectorSelection Style(VisioConnectorStyle style) #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:103

Returns: VisioConnectorSelection

Applies a reusable connector style on every selected connector.

Parameters

style OfficeIMO.Visio.VisioConnectorStyle requiredposition: 0: Connector style to apply.

System#Collections#IEnumerable#GetEnumerator() #

Inherited Methods

Properties

public virtual Int32 Count { get; } #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:27

public virtual VisioConnector Item { get; } #

OfficeIMO.Visio/Queries/VisioConnectorSelection.cs:30

Extension Methods

public static VisioConnectorSelection ApplyStyle(VisioConnectorSelection selection, VisioConnectorStyle style) #

OfficeIMO.Visio/Styles/VisioStyleExtensions.cs:47

Returns: VisioConnectorSelection

Applies a reusable style to a shape.

Parameters

shape OfficeIMO.Visio.VisioShape requiredposition: 0
style OfficeIMO.Visio.VisioShapeStyle requiredposition: 1

public static VisioConnectorSelection ApplyTextStyle(VisioConnectorSelection selection, VisioTextStyle style) #

OfficeIMO.Visio/Styles/VisioStyleExtensions.cs:109

Returns: VisioConnectorSelection

Applies a reusable text style to a shape.

Parameters

shape OfficeIMO.Visio.VisioShape requiredposition: 0
style OfficeIMO.Visio.VisioTextStyle requiredposition: 1

public static VisioConnectorSelection ClearRoutes(VisioConnectorSelection selection) #

OfficeIMO.Visio/Routing/VisioConnectorRoutingExtensions.cs:173

Returns: VisioConnectorSelection

Removes explicit connector routes from every selected connector.

Parameters

selection OfficeIMO.Visio.VisioConnectorSelection requiredposition: 0: Connector selection.

public static VisioConnectorSelection PlaceLabels(VisioConnectorSelection selection, Double position = 0.5, Double offsetX = 0, Double offsetY = 0, Double width = 1.25, Double height = 0.3)

OfficeIMO.Visio/Routing/VisioConnectorRoutingExtensions.cs:194

Returns: VisioConnectorSelection

Places connector text along every selected connector path.

Parameters

selection OfficeIMO.Visio.VisioConnectorSelection requiredposition: 0: Connector selection.
position System.Double = 0.5 optionalposition: 1: Position along each connector path, from 0.0 to 1.0.
offsetX System.Double = 0 optionalposition: 2: Horizontal page-coordinate offset.
offsetY System.Double = 0 optionalposition: 3: Vertical page-coordinate offset.
width System.Double = 1.25 optionalposition: 4: Label text box width in page units.
height System.Double = 0.3 optionalposition: 5: Label text box height in page units.

public static VisioConnectorSelection ResizeLabelsToText(VisioConnectorSelection selection, Nullable<OfficeFontInfo> fontInfo = null, Double horizontalPadding = 0.12, Double verticalPadding = 0.06, Double minimumWidth = 0.45, Double minimumHeight = 0.22, Nullable<Double> maximumWidth = null)

OfficeIMO.Visio/Layout/VisioLayoutExtensions.cs:547

Returns: VisioConnectorSelection

Resizes selected connector label text boxes to fit their plain text using deterministic OfficeIMO.Drawing measurement.

Parameters

selection OfficeIMO.Visio.VisioConnectorSelection requiredposition: 0: Connector selection.
fontInfo System.Nullable{OfficeIMO.Drawing.OfficeFontInfo} = null optionalposition: 1: Font descriptor used for measurement. Uses connector text style, then Office default, when omitted.
horizontalPadding System.Double = 0.12 optionalposition: 2: Horizontal padding in inches.
verticalPadding System.Double = 0.06 optionalposition: 3: Vertical padding in inches.
minimumWidth System.Double = 0.45 optionalposition: 4: Minimum resulting label width in inches.
minimumHeight System.Double = 0.22 optionalposition: 5: Minimum resulting label height in inches.
maximumWidth System.Nullable{System.Double} = null optionalposition: 6: Optional maximum label width in inches. Text wraps by words when supplied.

public static VisioConnectorSelection RouteOrthogonal(VisioConnectorSelection selection, VisioConnectorRouteStyle style = Auto, Double offset = 0)

OfficeIMO.Visio/Routing/VisioConnectorRoutingExtensions.cs:157

Returns: VisioConnectorSelection

Generates a clean three-segment orthogonal route between connector endpoints.

Parameters

connector OfficeIMO.Visio.VisioConnector requiredposition: 0: Connector to route.
style OfficeIMO.Visio.VisioConnectorRouteStyle = Auto optionalposition: 1: Orthogonal route orientation.
offset System.Double = 0 optionalposition: 2: Optional offset applied to the center routing lane.

public static VisioConnectorSelection RouteThrough(VisioConnectorSelection selection, params VisioConnectorWaypoint[] waypoints)

OfficeIMO.Visio/Routing/VisioConnectorRoutingExtensions.cs:139

Returns: VisioConnectorSelection

Replaces connector geometry with explicit page-coordinate waypoints.

Parameters

connector OfficeIMO.Visio.VisioConnector requiredposition: 0: Connector to route.
waypoints OfficeIMO.Visio.VisioConnectorWaypoint[] requiredposition: 1: Absolute page coordinates between start and end.