API Reference
Class
VisioBlockDiagramBuilder
High-level builder for block and system diagrams with grid placement, grouped regions, and semantic data/control flow connectors.
Inheritance
- Object
- VisioBlockDiagramBuilder
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 VisioBlockDiagramBuilder.Block
- Method VisioBlockDiagramBuilder.Callout
- Method VisioBlockDiagramBuilder.Callout
- Method VisioBlockDiagramBuilder.ControlFlow
- Method VisioBlockDiagramBuilder.DataFlow
- Method VisioBlockDiagramBuilder.EmphasisBlock
- Method VisioBlockDiagramBuilder.Legend
- Method VisioBlockDiagramBuilder.Margins
- Method VisioBlockDiagramBuilder.PageSize
- Method VisioBlockDiagramBuilder.Region
- Method VisioBlockDiagramBuilder.Theme
- Method VisioBlockDiagramBuilder.Title
Accepted by parameters
- Method VisioBlockDiagramDocumentExtensions.BlockDiagram
- Extension method VisioDocument.BlockDiagram
Methods
public VisioBlockDiagramBuilder Block(String id, String text, Int32 column, Int32 row, VisioBlockShapeKind kind = Block) #Returns:
VisioBlockDiagramBuilderAdds a standard block at a deterministic grid position.
Parameters
- id System.String
- text System.String
- column System.Int32
- row System.Int32
- kind OfficeIMO.Visio.Diagrams.VisioBlockShapeKind = Block
Callout 4 overloads
public VisioBlockDiagramBuilder Callout(String targetId, String text, VisioSide placement, Double gap = 0.35, Action<VisioCalloutOptions> configure = null) #Returns:
VisioBlockDiagramBuilderAdds a semantic callout connected to a known block using a generated callout id.
Parameters
- targetId System.String
- text System.String
- pinX System.Double
- pinY System.Double = 0.35
- configure System.Action{OfficeIMO.Visio.VisioCalloutOptions} = null
public VisioBlockDiagramBuilder Callout(String targetId, String id, String text, VisioSide placement, Double gap = 0.35, Action<VisioCalloutOptions> configure = null) #Returns:
VisioBlockDiagramBuilderAdds a semantic callout connected to a known block.
Parameters
- targetId System.String
- id System.String
- text System.String
- pinX System.Double
- pinY System.Double = 0.35
- configure System.Action{OfficeIMO.Visio.VisioCalloutOptions} = null
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 block using a generated callout id.
Parameters
- targetId System.String
- text System.String
- placement OfficeIMO.Visio.VisioSide
- gap System.Double
- configure System.Action{OfficeIMO.Visio.VisioCalloutOptions}
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 block.
Parameters
- targetId System.String
- id System.String
- text System.String
- placement OfficeIMO.Visio.VisioSide
- gap System.Double
- configure System.Action{OfficeIMO.Visio.VisioCalloutOptions}
public VisioBlockDiagramBuilder ControlFlow(String fromId, String toId, String label = null) #Returns:
VisioBlockDiagramBuilderAdds a dashed control-flow connector.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioBlockDiagramBuilder DataFlow(String fromId, String toId, String label = null) #Returns:
VisioBlockDiagramBuilderAdds a solid data-flow connector.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioBlockDiagramBuilder EmphasisBlock(String id, String text, Int32 column, Int32 row, VisioBlockShapeKind kind = Block) #Returns:
VisioBlockDiagramBuilderAdds an emphasized block at a deterministic grid position.
Parameters
- id System.String
- text System.String
- column System.Int32
- row System.Int32
- kind OfficeIMO.Visio.Diagrams.VisioBlockShapeKind = Block
public VisioBlockDiagramBuilder Legend(Boolean enabled = true, String dataFlowLabel = "Data Flow", String controlFlowLabel = "Control Flow") #Returns:
VisioBlockDiagramBuilderAdds a compact data/control flow legend above the generated grid.
Parameters
- enabled System.Boolean = true
- dataFlowLabel System.String = "Data Flow"
- controlFlowLabel System.String = "Control Flow"
public VisioBlockDiagramBuilder Margins(Double left, Double top) #Returns:
VisioBlockDiagramBuilderSets outer page margins used by the grid layout.
Parameters
- left System.Double
- top System.Double
public VisioBlockDiagramBuilder PageSize(Double width, Double height, VisioMeasurementUnit unit = Inches) #Returns:
VisioBlockDiagramBuilderSets the page size used by the generated block diagram page.
Parameters
- width System.Double
- height System.Double
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
public VisioBlockDiagramBuilder Region(String id, String text, Int32 column, Int32 row, Int32 columnSpan, Int32 rowSpan) #Returns:
VisioBlockDiagramBuilderAdds a light background region around a grid area.
Parameters
- id System.String
- text System.String
- column System.Int32
- row System.Int32
- columnSpan System.Int32
- rowSpan System.Int32
Theme 2 overloads
public VisioBlockDiagramBuilder Theme(VisioStyleTheme theme) #Returns:
VisioBlockDiagramBuilderSets the visual theme.
Parameters
- theme OfficeIMO.Visio.Diagrams.VisioBlockDiagramTheme
Theme(OfficeIMO.Visio.VisioStyleTheme theme) #Sets the visual theme from a reusable OfficeIMO Visio style theme.
Parameters
- theme OfficeIMO.Visio.VisioStyleTheme
public VisioBlockDiagramBuilder Title(String text = null, String id = "title", Double height = 0.45, Double gap = 0.35) #Returns:
VisioBlockDiagramBuilderAdds a centered title above the generated grid.
Parameters
- text System.String = null
- id System.String = "title"
- height System.Double = 0.45
- gap System.Double = 0.35