API Reference
Class
VisioFluentConnector
Fluent helper for configuring a connector between two shapes.
Inheritance
- Object
- VisioFluentConnector
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 VisioFluentConnector.ArrowEnd
- Method VisioFluentConnector.ArrowStart
- Method VisioFluentConnector.AutoSizeLabel
- Method VisioFluentConnector.ClearRoute
- Method VisioFluentConnector.ClearRoutingPolicy
- Method VisioFluentConnector.Curved
- Method VisioFluentConnector.Dynamic
- Method VisioFluentConnector.FromSide
- Method VisioFluentConnector.Hyperlink
- Method VisioFluentConnector.Label
- Method VisioFluentConnector.Label
- Method VisioFluentConnector.LabelAt
- Method VisioFluentConnector.LabelPosition
- Method VisioFluentConnector.Layer
- Method VisioFluentConnector.LineColor
- Method VisioFluentConnector.LineJumps
- Method VisioFluentConnector.LinePattern
- Method VisioFluentConnector.LineWeight
- Method VisioFluentConnector.LockEndpoints
- Method VisioFluentConnector.Protect
- Method VisioFluentConnector.RerouteBehavior
- Method VisioFluentConnector.RightAngle
- Method VisioFluentConnector.RouteAppearance
- Method VisioFluentConnector.RouteOrthogonal
- Method VisioFluentConnector.RouteStyle
- Method VisioFluentConnector.RouteThrough
- Method VisioFluentConnector.Sides
- Method VisioFluentConnector.Straight
- Method VisioFluentConnector.Style
- Method VisioFluentConnector.TextStyle
- Method VisioFluentConnector.ToSide
Accepted by parameters
- Method VisioFluentPage.Connect
- Method VisioFluentPage.Connect
Constructors
VisioFluentConnector(OfficeIMO.Visio.VisioConnector connector) #Initializes a new connector wrapper.
Parameters
- connector OfficeIMO.Visio.VisioConnector
- Underlying connector model.
Methods
public VisioFluentConnector ArrowEnd(EndArrow arrow) #Returns:
VisioFluentConnectorSets an end arrowhead style.
Parameters
- arrow OfficeIMO.Visio.EndArrow
- Arrowhead enum value.
public VisioFluentConnector ArrowStart(EndArrow arrow) #Returns:
VisioFluentConnectorSets a begin arrowhead style.
Parameters
- arrow OfficeIMO.Visio.EndArrow
- Arrowhead enum value.
public VisioFluentConnector AutoSizeLabel(Nullable<OfficeFontInfo> fontInfo = null, Nullable<Double> maximumWidth = null) #Returns:
VisioFluentConnectorResizes the connector label text box to fit its label text.
Parameters
- fontInfo System.Nullable{OfficeIMO.Drawing.OfficeFontInfo} = null
- Font descriptor used for measurement. Uses connector text style, then Office default, when omitted.
- maximumWidth System.Nullable{System.Double} = null
- Optional maximum label width in inches.
public VisioFluentConnector ClearRoute() #Returns:
VisioFluentConnectorRemoves explicit waypoints and returns to dynamic routing.
public VisioFluentConnector ClearRoutingPolicy() #Returns:
VisioFluentConnectorClears explicit Shape Layout routing override cells.
public VisioFluentConnector Curved() #Returns:
VisioFluentConnectorSets connector kind to curved routing.
public VisioFluentConnector Dynamic() #Returns:
VisioFluentConnectorSets connector kind to dynamic routing.
public VisioFluentConnector FromSide(VisioSide side) #Returns:
VisioFluentConnectorConnects the start of the connector to an explicit side.
Parameters
- side OfficeIMO.Visio.VisioSide
- Preferred source side.
public VisioFluentConnector Hyperlink(String address, String description = null, String subAddress = null) #Returns:
VisioFluentConnectorAdds a hyperlink to the connector.
Parameters
- address System.String
- External hyperlink address.
- description System.String = null
- Optional display description.
- subAddress System.String = null
- Optional internal sub-address.
Label 2 overloads
public VisioFluentConnector Label(String text) #Returns:
VisioFluentConnectorSets a connector label.
Parameters
- text System.String
- Label text.
public VisioFluentConnector Label(String text, Double position, Double offsetX = 0, Double offsetY = 0) #Returns:
VisioFluentConnectorSets a connector label and places it along the connector path.
Parameters
- text System.String
- Label text.
- position System.Double
- Position along the connector path, from 0.0 to 1.0.
- offsetX System.Double = 0
- Horizontal page-coordinate offset.
- offsetY System.Double = 0
- Vertical page-coordinate offset.
public VisioFluentConnector LabelAt(Double pinX, Double pinY, Double width = 1.25, Double height = 0.3) #Returns:
VisioFluentConnectorPlaces connector text at an absolute page coordinate.
Parameters
- pinX System.Double
- Text pin X coordinate.
- pinY System.Double
- Text pin Y coordinate.
- width System.Double = 1.25
- Label text box width in page units.
- height System.Double = 0.3
- Label text box height in page units.
public VisioFluentConnector LabelPosition(Double position = 0.5, Double offsetX = 0, Double offsetY = 0, Double width = 1.25, Double height = 0.3) #Returns:
VisioFluentConnectorPlaces connector text along the connector path.
Parameters
- position System.Double = 0.5
- Position along the connector path, from 0.0 to 1.0.
- offsetX System.Double = 0
- Horizontal page-coordinate offset.
- offsetY System.Double = 0
- Vertical page-coordinate offset.
- width System.Double = 1.25
- Label text box width in page units.
- height System.Double = 0.3
- Label text box height in page units.
public VisioFluentConnector Layer(String layerName) #Returns:
VisioFluentConnectorAdds the connector to a page layer.
Parameters
- layerName System.String
- Layer name.
public VisioFluentConnector LineColor(OfficeColor color) #Returns:
VisioFluentConnectorSets connector line color.
Parameters
- color OfficeIMO.Drawing.OfficeColor
- Line color.
public VisioFluentConnector LineJumps(VisioLineJumpStyle style, VisioConnectorLineJumpCode code, VisioHorizontalLineJumpDirection horizontalDirection = Default, VisioVerticalLineJumpDirection verticalDirection = Default) #Returns:
VisioFluentConnectorSets connector-level line jump behavior.
Parameters
- style OfficeIMO.Visio.VisioLineJumpStyle
- code OfficeIMO.Visio.VisioConnectorLineJumpCode
- horizontalDirection OfficeIMO.Visio.VisioHorizontalLineJumpDirection = Default
- verticalDirection OfficeIMO.Visio.VisioVerticalLineJumpDirection = Default
public VisioFluentConnector LinePattern(Int32 pattern) #Returns:
VisioFluentConnectorSets connector line pattern (Visio pattern index).
Parameters
- pattern System.Int32
- Pattern index (0=None, 1=Solid, ...).
public VisioFluentConnector LineWeight(Double weight) #Returns:
VisioFluentConnectorSets connector line weight (thickness) in inches.
Parameters
- weight System.Double
- Line weight in inches.
public VisioFluentConnector LockEndpoints(Boolean locked = true) #Returns:
VisioFluentConnectorLocks or unlocks connector endpoints.
Parameters
- locked System.Boolean = true
- Whether endpoints are locked.
public VisioFluentConnector Protect(Action<VisioProtection> configure) #Returns:
VisioFluentConnectorConfigures ShapeSheet protection cells.
Parameters
- configure System.Action{OfficeIMO.Visio.VisioProtection}
- Protection configuration delegate.
public VisioFluentConnector RerouteBehavior(VisioConnectorRerouteBehavior behavior) #Returns:
VisioFluentConnectorSets when Visio may reroute this connector.
Parameters
- behavior OfficeIMO.Visio.VisioConnectorRerouteBehavior
public VisioFluentConnector RightAngle() #Returns:
VisioFluentConnectorSets connector kind to right-angle (orthogonal) routing.
public VisioFluentConnector RouteAppearance(VisioLineRouteExtension appearance) #Returns:
VisioFluentConnectorSets the connector-level routed connector appearance.
Parameters
- appearance OfficeIMO.Visio.VisioLineRouteExtension
public VisioFluentConnector RouteOrthogonal(VisioConnectorRouteStyle style = Auto, Double offset = 0) #Returns:
VisioFluentConnectorGenerates a clean orthogonal route for the connector.
Parameters
- style OfficeIMO.Visio.VisioConnectorRouteStyle = Auto
- Orthogonal route orientation.
- offset System.Double = 0
- Optional offset applied to the center routing lane.
public VisioFluentConnector RouteStyle(VisioPageRouteStyle style) #Returns:
VisioFluentConnectorSets the connector-level Visio routing style.
Parameters
- style OfficeIMO.Visio.VisioPageRouteStyle
public VisioFluentConnector RouteThrough(params VisioConnectorWaypoint[] waypoints) #Returns:
VisioFluentConnectorRoutes the connector through explicit page-coordinate waypoints.
Parameters
- waypoints OfficeIMO.Visio.VisioConnectorWaypoint[]
- Absolute page coordinates between start and end.
public VisioFluentConnector Sides(VisioSide fromSide, VisioSide toSide) #Returns:
VisioFluentConnectorConnects both ends to explicit shape sides.
Parameters
- fromSide OfficeIMO.Visio.VisioSide
- Preferred source side.
- toSide OfficeIMO.Visio.VisioSide
- Preferred target side.
public VisioFluentConnector Straight() #Returns:
VisioFluentConnectorSets connector kind to a straight line.
public VisioFluentConnector Style(VisioConnectorStyle style) #Returns:
VisioFluentConnectorApplies a reusable connector style.
Parameters
- style OfficeIMO.Visio.VisioConnectorStyle
- Connector style to apply.
public VisioFluentConnector TextStyle(VisioTextStyle style) #Returns:
VisioFluentConnectorApplies reusable text formatting to the connector label.
Parameters
- style OfficeIMO.Visio.VisioTextStyle
- Text style to apply.
public VisioFluentConnector ToSide(VisioSide side) #Returns:
VisioFluentConnectorConnects the end of the connector to an explicit side.
Parameters
- side OfficeIMO.Visio.VisioSide
- Preferred target side.
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object