API Reference
Class
VisioGraphDiagramBuilder
High-level builder for generic graph diagrams where OfficeIMO lays out arbitrary nodes and edges.
Inheritance
- Object
- VisioGraphDiagramBuilder
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 VisioGraphDiagramBuilder.ControlEdge
- Method VisioGraphDiagramBuilder.ControlEdge
- Method VisioGraphDiagramBuilder.DataEdge
- Method VisioGraphDiagramBuilder.DataEdge
- Method VisioGraphDiagramBuilder.Direction
- Method VisioGraphDiagramBuilder.Edge
- Method VisioGraphDiagramBuilder.Edge
- Method VisioGraphDiagramBuilder.Edge
- Method VisioGraphDiagramBuilder.Edge
- Method VisioGraphDiagramBuilder.EdgeHyperlink
- Method VisioGraphDiagramBuilder.EdgeHyperlink
- Method VisioGraphDiagramBuilder.EdgeShapeData
- Method VisioGraphDiagramBuilder.EdgeStyle
- Method VisioGraphDiagramBuilder.EmphasisEdge
- Method VisioGraphDiagramBuilder.EmphasisEdge
- Method VisioGraphDiagramBuilder.FitPageToGraph
- Method VisioGraphDiagramBuilder.Layout
- Method VisioGraphDiagramBuilder.Margins
- Method VisioGraphDiagramBuilder.NamedControlEdge
- Method VisioGraphDiagramBuilder.NamedControlEdge
- Method VisioGraphDiagramBuilder.NamedDataEdge
- Method VisioGraphDiagramBuilder.NamedDataEdge
- Method VisioGraphDiagramBuilder.NamedEdge
- Method VisioGraphDiagramBuilder.NamedEdge
- Method VisioGraphDiagramBuilder.NamedEmphasisEdge
- Method VisioGraphDiagramBuilder.NamedEmphasisEdge
- Method VisioGraphDiagramBuilder.NamedRelationship
- Method VisioGraphDiagramBuilder.NamedRelationship
- Method VisioGraphDiagramBuilder.Node
- Method VisioGraphDiagramBuilder.NodeHyperlink
- Method VisioGraphDiagramBuilder.NodeHyperlink
- Method VisioGraphDiagramBuilder.NodeShapeData
- Method VisioGraphDiagramBuilder.NodeSize
- Method VisioGraphDiagramBuilder.NodeStyle
- Method VisioGraphDiagramBuilder.PageSize
- Method VisioGraphDiagramBuilder.Relationship
- Method VisioGraphDiagramBuilder.Relationship
- Method VisioGraphDiagramBuilder.Root
- Method VisioGraphDiagramBuilder.Root
- Method VisioGraphDiagramBuilder.Spacing
- Method VisioGraphDiagramBuilder.StencilNode
- Method VisioGraphDiagramBuilder.StencilNode
- Method VisioGraphDiagramBuilder.Theme
- Method VisioGraphDiagramBuilder.Title
- Method VisioGraphDiagramBuilder.Zone
Accepted by parameters
- Method VisioGraphDiagramDocumentExtensions.GraphDiagram
- Extension method VisioDocument.GraphDiagram
Methods
ControlEdge 2 overloads
public VisioGraphDiagramBuilder ControlEdge(String fromId, String toId, String label = null) #Returns:
VisioGraphDiagramBuilderAdds a control-flow graph edge.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioGraphDiagramBuilder ControlEdge(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named control-flow graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
DataEdge 2 overloads
public VisioGraphDiagramBuilder DataEdge(String fromId, String toId, String label = null) #Returns:
VisioGraphDiagramBuilderAdds a data-flow graph edge.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioGraphDiagramBuilder DataEdge(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named data-flow graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
public VisioGraphDiagramBuilder Direction(VisioGraphDirection direction) #Returns:
VisioGraphDiagramBuilderSets the primary flow direction for layered layouts.
Parameters
- direction OfficeIMO.Visio.Diagrams.VisioGraphDirection
Edge 4 overloads
public VisioGraphDiagramBuilder Edge(String fromId, String toId, String label = null) #Returns:
VisioGraphDiagramBuilderAdds a standard directed graph edge.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioGraphDiagramBuilder Edge(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named standard directed graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
public VisioGraphDiagramBuilder Edge(String fromId, String toId, VisioGraphConnectorKind kind, String label = null, Boolean directed = true) #Returns:
VisioGraphDiagramBuilderAdds a graph edge between two known nodes.
Parameters
- fromId System.String
- toId System.String
- kind OfficeIMO.Visio.Diagrams.VisioGraphConnectorKind
- label System.String = null
- directed System.Boolean = true
public VisioGraphDiagramBuilder Edge(String edgeId, String fromId, String toId, VisioGraphConnectorKind kind, String label = null, Boolean directed = true) #Returns:
VisioGraphDiagramBuilderAdds a named graph edge between two known nodes.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- kind OfficeIMO.Visio.Diagrams.VisioGraphConnectorKind
- label System.String = null
- directed System.Boolean = true
EdgeHyperlink 2 overloads
public VisioGraphDiagramBuilder EdgeHyperlink(String edgeId, String address, String description = null, String subAddress = null) #Returns:
VisioGraphDiagramBuilderAdds a hyperlink that will be written to a named graph edge connector.
Parameters
- edgeId System.String
- address System.String
- description System.String = null
- subAddress System.String = null
public VisioGraphDiagramBuilder EdgeHyperlink(String edgeId, Uri address, String description = null, String subAddress = null) #Returns:
VisioGraphDiagramBuilderAdds a hyperlink that will be written to a named graph edge connector.
Parameters
- edgeId System.String
- address System.Uri
- description System.String = null
- subAddress System.String = null
public VisioGraphDiagramBuilder EdgeShapeData(String edgeId, String name, String value, String label = null, Nullable<VisioShapeDataType> type = null, String prompt = null, String format = null) #Returns:
VisioGraphDiagramBuilderAdds or replaces Shape Data on a named graph edge connector.
Parameters
- edgeId System.String
- name System.String
- value System.String
- label System.String = null
- type System.Nullable{OfficeIMO.Visio.VisioShapeDataType} = null
- prompt System.String = null
- format System.String = null
EdgeStyle 2 overloads
public VisioGraphDiagramBuilder EdgeStyle(String edgeId, Action<VisioConnectorStyle> configure) #Returns:
VisioGraphDiagramBuilderOverrides the visual style for a named graph edge connector.
Parameters
- edgeId System.String
- style OfficeIMO.Visio.VisioConnectorStyle
EdgeStyle(System.String edgeId, System.Action{OfficeIMO.Visio.VisioConnectorStyle} configure) #Overrides the visual style for a named graph edge connector by editing a theme-derived style copy.
Parameters
- edgeId System.String
- configure System.Action{OfficeIMO.Visio.VisioConnectorStyle}
EmphasisEdge 2 overloads
public VisioGraphDiagramBuilder EmphasisEdge(String fromId, String toId, String label = null) #Returns:
VisioGraphDiagramBuilderAdds an emphasized graph edge.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioGraphDiagramBuilder EmphasisEdge(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named emphasized graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
public VisioGraphDiagramBuilder FitPageToGraph(Boolean enabled = true) #Returns:
VisioGraphDiagramBuilderSets whether the builder can grow the page to fit the graph. Enabled by default.
Parameters
- enabled System.Boolean = true
public VisioGraphDiagramBuilder Layout(VisioGraphLayout layout) #Returns:
VisioGraphDiagramBuilderSets the automatic graph layout strategy.
Parameters
- layout OfficeIMO.Visio.Diagrams.VisioGraphLayout
public VisioGraphDiagramBuilder Margins(Double left, Double top, Double right = 0.8, Double bottom = 0.8) #Returns:
VisioGraphDiagramBuilderSets outer page margins used by automatic layout.
Parameters
- left System.Double
- top System.Double
- right System.Double = 0.8
- bottom System.Double = 0.8
NamedControlEdge 2 overloads
public VisioGraphDiagramBuilder NamedControlEdge(String edgeId, String fromId, String toId) #Returns:
VisioGraphDiagramBuilderAdds an unlabeled named control-flow graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
public VisioGraphDiagramBuilder NamedControlEdge(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named control-flow graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
NamedDataEdge 2 overloads
public VisioGraphDiagramBuilder NamedDataEdge(String edgeId, String fromId, String toId) #Returns:
VisioGraphDiagramBuilderAdds an unlabeled named data-flow graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
public VisioGraphDiagramBuilder NamedDataEdge(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named data-flow graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
NamedEdge 2 overloads
public VisioGraphDiagramBuilder NamedEdge(String edgeId, String fromId, String toId) #Returns:
VisioGraphDiagramBuilderAdds an unlabeled named standard directed graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
public VisioGraphDiagramBuilder NamedEdge(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named standard directed graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
NamedEmphasisEdge 2 overloads
public VisioGraphDiagramBuilder NamedEmphasisEdge(String edgeId, String fromId, String toId) #Returns:
VisioGraphDiagramBuilderAdds an unlabeled named emphasized graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
public VisioGraphDiagramBuilder NamedEmphasisEdge(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named emphasized graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
NamedRelationship 2 overloads
public VisioGraphDiagramBuilder NamedRelationship(String edgeId, String fromId, String toId) #Returns:
VisioGraphDiagramBuilderAdds an unlabeled named undirected graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
public VisioGraphDiagramBuilder NamedRelationship(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named undirected graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
public VisioGraphDiagramBuilder Node(String id, String text, VisioGraphNodeKind kind = Process) #Returns:
VisioGraphDiagramBuilderAdds a native graph node.
Parameters
- id System.String
- text System.String
- kind OfficeIMO.Visio.Diagrams.VisioGraphNodeKind = Process
NodeHyperlink 2 overloads
public VisioGraphDiagramBuilder NodeHyperlink(String nodeId, String address, String description = null, String subAddress = null) #Returns:
VisioGraphDiagramBuilderAdds a hyperlink that will be written to a graph node.
Parameters
- nodeId System.String
- address System.String
- description System.String = null
- subAddress System.String = null
public VisioGraphDiagramBuilder NodeHyperlink(String nodeId, Uri address, String description = null, String subAddress = null) #Returns:
VisioGraphDiagramBuilderAdds a hyperlink that will be written to a graph node.
Parameters
- nodeId System.String
- address System.Uri
- description System.String = null
- subAddress System.String = null
public VisioGraphDiagramBuilder NodeShapeData(String nodeId, String name, String value, String label = null, Nullable<VisioShapeDataType> type = null, String prompt = null, String format = null) #Returns:
VisioGraphDiagramBuilderAdds or updates Shape Data metadata that will be written to a graph node.
Parameters
- nodeId System.String
- name System.String
- value System.String
- label System.String = null
- type System.Nullable{OfficeIMO.Visio.VisioShapeDataType} = null
- prompt System.String = null
- format System.String = null
public VisioGraphDiagramBuilder NodeSize(Double width, Double height) #Returns:
VisioGraphDiagramBuilderSets the default node size used for native graph nodes.
Parameters
- width System.Double
- height System.Double
NodeStyle 2 overloads
public VisioGraphDiagramBuilder NodeStyle(String nodeId, Action<VisioShapeStyle> configure) #Returns:
VisioGraphDiagramBuilderOverrides the visual style for a graph node.
Parameters
- nodeId System.String
- style OfficeIMO.Visio.VisioShapeStyle
NodeStyle(System.String nodeId, System.Action{OfficeIMO.Visio.VisioShapeStyle} configure) #Overrides the visual style for a graph node by editing a theme-derived style copy.
Parameters
- nodeId System.String
- configure System.Action{OfficeIMO.Visio.VisioShapeStyle}
public VisioGraphDiagramBuilder PageSize(Double width, Double height, VisioMeasurementUnit unit = Inches) #Returns:
VisioGraphDiagramBuilderSets the page size used by the generated graph page.
Parameters
- width System.Double
- height System.Double
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
Relationship 2 overloads
public VisioGraphDiagramBuilder Relationship(String fromId, String toId, String label = null) #Returns:
VisioGraphDiagramBuilderAdds an undirected graph edge.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioGraphDiagramBuilder Relationship(String edgeId, String fromId, String toId, String label) #Returns:
VisioGraphDiagramBuilderAdds a named undirected graph edge.
Parameters
- edgeId System.String
- fromId System.String
- toId System.String
- label System.String
Root 2 overloads
public VisioGraphDiagramBuilder Root(String id, String text, VisioGraphNodeKind kind = External) #Returns:
VisioGraphDiagramBuilderAdds and marks a root node used by layered and radial layout.
Parameters
- id System.String
- text System.String
- kind OfficeIMO.Visio.Diagrams.VisioGraphNodeKind = External
public VisioGraphDiagramBuilder Root(String id) #Returns:
VisioGraphDiagramBuilderMarks an existing node as a root used by layered and radial layout.
Parameters
- id System.String
public VisioGraphDiagramBuilder Spacing(Double columnGap, Double rowGap) #Returns:
VisioGraphDiagramBuilderSets spacing between layers/columns and rows/rings.
Parameters
- columnGap System.Double
- rowGap System.Double
StencilNode 2 overloads
public VisioGraphDiagramBuilder StencilNode(String id, String text, VisioStencilShape stencil) #Returns:
VisioGraphDiagramBuilderAdds a graph node backed by an OfficeIMO, installed Visio, or external package stencil.
Parameters
- id System.String
- text System.String
- stencil OfficeIMO.Visio.Stencils.VisioStencilShape
public VisioGraphDiagramBuilder StencilNode(String id, String text, VisioStencilCatalog catalog, params String[] stencilQueries) #Returns:
VisioGraphDiagramBuilderAdds a graph node backed by the first matching stencil in a catalog.
Parameters
- id System.String
- text System.String
- catalog OfficeIMO.Visio.Stencils.VisioStencilCatalog
- stencilQueries System.String[]
public VisioGraphDiagramBuilder Theme(VisioStyleTheme theme) #Returns:
VisioGraphDiagramBuilderSets the visual theme.
Parameters
- theme OfficeIMO.Visio.VisioStyleTheme
public VisioGraphDiagramBuilder Title(String text = null, String id = "title", Double height = 0.45, Double gap = 0.35) #Returns:
VisioGraphDiagramBuilderAdds a centered editable title above the graph.
Parameters
- text System.String = null
- id System.String = "title"
- height System.Double = 0.45
- gap System.Double = 0.35
public VisioGraphDiagramBuilder Zone(String id, String text, params String[] nodeIds) #Returns:
VisioGraphDiagramBuilderAdds a background zone around graph nodes.
Parameters
- id System.String
- text System.String
- nodeIds System.String[]