API Reference

Class

VisioNetworkTopologyDiagramBuilder

Namespace OfficeIMO.Visio.Diagrams
Assembly OfficeIMO.Visio
Modifiers sealed

High-level builder for network topologies where OfficeIMO places devices from links.

Inheritance

  • Object
  • VisioNetworkTopologyDiagramBuilder

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

Accepted by parameters

Methods

Callout 4 overloads
public VisioNetworkTopologyDiagramBuilder Callout(String targetId, String text, VisioSide placement, Double gap = 0.35, Action<VisioCalloutOptions> configure = null) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a semantic callout connected to a known topology node using a generated callout id.

Parameters

targetId System.String requiredposition: 0
text System.String requiredposition: 1
pinX System.Double requiredposition: 2
pinY System.Double = 0.35 optionalposition: 3
configure System.Action{OfficeIMO.Visio.VisioCalloutOptions} = null optionalposition: 4
public VisioNetworkTopologyDiagramBuilder Callout(String targetId, String id, String text, VisioSide placement, Double gap = 0.35, Action<VisioCalloutOptions> configure = null) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a semantic callout connected to a known topology node.

Parameters

targetId System.String requiredposition: 0
id System.String requiredposition: 1
text System.String requiredposition: 2
pinX System.Double requiredposition: 3
pinY System.Double = 0.35 optionalposition: 4
configure System.Action{OfficeIMO.Visio.VisioCalloutOptions} = null optionalposition: 5
Callout(System.String targetId, System.String text, OfficeIMO.Visio.VisioSide placement, System.Double gap, System.Action{OfficeIMO.Visio.VisioCalloutOptions} configure) #

Adds a semantic callout placed beside a known topology node using a generated callout id.

Parameters

targetId System.String required
text System.String required
placement OfficeIMO.Visio.VisioSide required
gap System.Double required
configure System.Action{OfficeIMO.Visio.VisioCalloutOptions} required
Callout(System.String targetId, System.String id, System.String text, OfficeIMO.Visio.VisioSide placement, System.Double gap, System.Action{OfficeIMO.Visio.VisioCalloutOptions} configure) #

Adds a semantic callout placed beside a known topology node.

Parameters

targetId System.String required
id System.String required
text System.String required
placement OfficeIMO.Visio.VisioSide required
gap System.Double required
configure System.Action{OfficeIMO.Visio.VisioCalloutOptions} required
public VisioNetworkTopologyDiagramBuilder Database(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a database node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Ethernet(String fromId, String toId, String label = null) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a standard network link.

Parameters

fromId System.String requiredposition: 0
toId System.String requiredposition: 1
label System.String = null optionalposition: 2
public VisioNetworkTopologyDiagramBuilder Firewall(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a firewall node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder FitPageToTopology(Boolean enabled = true) #
Returns: VisioNetworkTopologyDiagramBuilder

Sets whether the builder can grow the page to fit the topology. Enabled by default.

Parameters

enabled System.Boolean = true optionalposition: 0
public VisioNetworkTopologyDiagramBuilder Internet(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds an Internet/external network node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Legend(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a note or legend node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Management(String fromId, String toId, String label = null) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a management connection.

Parameters

fromId System.String requiredposition: 0
toId System.String requiredposition: 1
label System.String = null optionalposition: 2
public VisioNetworkTopologyDiagramBuilder Margins(Double left, Double top, Double right = 0.8, Double bottom = 0.8) #
Returns: VisioNetworkTopologyDiagramBuilder

Sets outer page margins used by the automatic layout.

Parameters

left System.Double requiredposition: 0
top System.Double requiredposition: 1
right System.Double = 0.8 optionalposition: 2
bottom System.Double = 0.8 optionalposition: 3
public VisioNetworkTopologyDiagramBuilder Node(String id, String text, VisioNetworkNodeKind kind = Server) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a network node that will be placed by automatic topology layout.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
kind OfficeIMO.Visio.Diagrams.VisioNetworkNodeKind = Server optionalposition: 2
public VisioNetworkTopologyDiagramBuilder NodeSize(Double width, Double height) #
Returns: VisioNetworkTopologyDiagramBuilder

Sets the default network node size.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
public VisioNetworkTopologyDiagramBuilder PageSize(Double width, Double height, VisioMeasurementUnit unit = Inches) #
Returns: VisioNetworkTopologyDiagramBuilder

Sets the page size used by the generated topology page.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
unit OfficeIMO.Visio.VisioMeasurementUnit = Inches optionalposition: 2
public VisioNetworkTopologyDiagramBuilder Printer(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a printer node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
Root 2 overloads
public VisioNetworkTopologyDiagramBuilder Root(String id, String text, VisioNetworkNodeKind kind = Internet) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds and marks a root node used as the starting point for automatic layout.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
kind OfficeIMO.Visio.Diagrams.VisioNetworkNodeKind = Internet optionalposition: 2
public VisioNetworkTopologyDiagramBuilder Root(String id) #
Returns: VisioNetworkTopologyDiagramBuilder

Marks an existing node as a root used by automatic layout.

Parameters

id System.String requiredposition: 0
public VisioNetworkTopologyDiagramBuilder Router(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a router node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Server(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a server node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Spacing(Double columnGap, Double rowGap) #
Returns: VisioNetworkTopologyDiagramBuilder

Sets spacing between automatic layers and rows.

Parameters

columnGap System.Double requiredposition: 0
rowGap System.Double requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Storage(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a storage node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Subnet(String id, String text, params String[] nodeIds) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a subnet-style background zone around automatically placed topology nodes.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
nodeIds System.String[] requiredposition: 2
public VisioNetworkTopologyDiagramBuilder Switch(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a switch node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Theme(VisioStyleTheme theme) #
Returns: VisioNetworkTopologyDiagramBuilder

Sets the visual theme.

Parameters

theme OfficeIMO.Visio.VisioStyleTheme requiredposition: 0
public VisioNetworkTopologyDiagramBuilder Title(String text = null, String id = "title", Double height = 0.45, Double gap = 0.35) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a centered editable title above the automatically placed topology.

Parameters

text System.String = null optionalposition: 0
id System.String = "title" optionalposition: 1
height System.Double = 0.45 optionalposition: 2
gap System.Double = 0.35 optionalposition: 3
public VisioNetworkTopologyDiagramBuilder Trunk(String fromId, String toId, String label = null) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a trunk/uplink connection.

Parameters

fromId System.String requiredposition: 0
toId System.String requiredposition: 1
label System.String = null optionalposition: 2
public VisioNetworkTopologyDiagramBuilder User(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a user/client node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Wireless(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a wireless access point node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Workstation(String id, String text) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a workstation node.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioNetworkTopologyDiagramBuilder Zone(String id, String text, params String[] nodeIds) #
Returns: VisioNetworkTopologyDiagramBuilder

Adds a background zone around automatically placed topology nodes.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
nodeIds System.String[] requiredposition: 2