API Reference
Class
VisioSwimlaneDiagramBuilder
High-level builder for dependency-free swimlane and cross-functional process diagrams.
Inheritance
- Object
- VisioSwimlaneDiagramBuilder
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 VisioSwimlaneDiagramBuilder.Activity
- Method VisioSwimlaneDiagramBuilder.ActivitySize
- Method VisioSwimlaneDiagramBuilder.ActivityStackGap
- Method VisioSwimlaneDiagramBuilder.Callout
- Method VisioSwimlaneDiagramBuilder.Callout
- Method VisioSwimlaneDiagramBuilder.Data
- Method VisioSwimlaneDiagramBuilder.Decision
- Method VisioSwimlaneDiagramBuilder.End
- Method VisioSwimlaneDiagramBuilder.Exception
- Method VisioSwimlaneDiagramBuilder.Flow
- Method VisioSwimlaneDiagramBuilder.GridSize
- Method VisioSwimlaneDiagramBuilder.Handoff
- Method VisioSwimlaneDiagramBuilder.Lane
- Method VisioSwimlaneDiagramBuilder.Margins
- Method VisioSwimlaneDiagramBuilder.PageSize
- Method VisioSwimlaneDiagramBuilder.Phase
- Method VisioSwimlaneDiagramBuilder.Start
- Method VisioSwimlaneDiagramBuilder.Step
- Method VisioSwimlaneDiagramBuilder.Theme
- Method VisioSwimlaneDiagramBuilder.Title
Accepted by parameters
- Method VisioSwimlaneDiagramDocumentExtensions.SwimlaneDiagram
- Extension method VisioDocument.SwimlaneDiagram
Methods
public VisioSwimlaneDiagramBuilder Activity(String id, String text, String laneId, String phaseId, VisioSwimlaneActivityKind kind = Step) #Returns:
VisioSwimlaneDiagramBuilderAdds an activity in a lane and phase.
Parameters
- id System.String
- text System.String
- laneId System.String
- phaseId System.String
- kind OfficeIMO.Visio.Diagrams.VisioSwimlaneActivityKind = Step
public VisioSwimlaneDiagramBuilder ActivitySize(Double width, Double height) #Returns:
VisioSwimlaneDiagramBuilderSets the default activity size.
Parameters
- width System.Double
- height System.Double
public VisioSwimlaneDiagramBuilder ActivityStackGap(Double gap) #Returns:
VisioSwimlaneDiagramBuilderSets the vertical gap used when multiple activities share the same lane/phase cell.
Parameters
- gap System.Double
Callout 4 overloads
public VisioSwimlaneDiagramBuilder Callout(String targetId, String text, VisioSide placement, Double gap = 0.35, Action<VisioCalloutOptions> configure = null) #Returns:
VisioSwimlaneDiagramBuilderAdds a semantic callout connected to a known swimlane activity 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 VisioSwimlaneDiagramBuilder Callout(String targetId, String id, String text, VisioSide placement, Double gap = 0.35, Action<VisioCalloutOptions> configure = null) #Returns:
VisioSwimlaneDiagramBuilderAdds a semantic callout connected to a known swimlane activity.
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 swimlane activity 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 swimlane activity.
Parameters
- targetId System.String
- id System.String
- text System.String
- placement OfficeIMO.Visio.VisioSide
- gap System.Double
- configure System.Action{OfficeIMO.Visio.VisioCalloutOptions}
public VisioSwimlaneDiagramBuilder Data(String id, String text, String laneId, String phaseId) #Returns:
VisioSwimlaneDiagramBuilderAdds a data/input/output activity.
Parameters
- id System.String
- text System.String
- laneId System.String
- phaseId System.String
public VisioSwimlaneDiagramBuilder Decision(String id, String text, String laneId, String phaseId) #Returns:
VisioSwimlaneDiagramBuilderAdds a decision activity.
Parameters
- id System.String
- text System.String
- laneId System.String
- phaseId System.String
public VisioSwimlaneDiagramBuilder End(String id, String text, String laneId, String phaseId) #Returns:
VisioSwimlaneDiagramBuilderAdds an end activity.
Parameters
- id System.String
- text System.String
- laneId System.String
- phaseId System.String
public VisioSwimlaneDiagramBuilder Exception(String fromId, String toId, String label = null) #Returns:
VisioSwimlaneDiagramBuilderAdds an exception or alternate-path flow.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioSwimlaneDiagramBuilder Flow(String fromId, String toId, String label = null) #Returns:
VisioSwimlaneDiagramBuilderAdds a standard process flow.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioSwimlaneDiagramBuilder GridSize(Double phaseWidth, Double laneHeight, Double laneHeaderWidth = 1.35, Double phaseHeaderHeight = 0.55) #Returns:
VisioSwimlaneDiagramBuilderSets lane and phase dimensions.
Parameters
- phaseWidth System.Double
- laneHeight System.Double
- laneHeaderWidth System.Double = 1.35
- phaseHeaderHeight System.Double = 0.55
public VisioSwimlaneDiagramBuilder Handoff(String fromId, String toId, String label = null) #Returns:
VisioSwimlaneDiagramBuilderAdds a cross-lane handoff flow.
Parameters
- fromId System.String
- toId System.String
- label System.String = null
public VisioSwimlaneDiagramBuilder Lane(String id, String text) #Returns:
VisioSwimlaneDiagramBuilderAdds a horizontal lane for a role, team, or system.
Parameters
- id System.String
- text System.String
public VisioSwimlaneDiagramBuilder Margins(Double left, Double top, Double right = 0.6, Double bottom = 0.6) #Returns:
VisioSwimlaneDiagramBuilderSets the outer page margins.
Parameters
- left System.Double
- top System.Double
- right System.Double = 0.6
- bottom System.Double = 0.6
public VisioSwimlaneDiagramBuilder PageSize(Double width, Double height, VisioMeasurementUnit unit = Inches) #Returns:
VisioSwimlaneDiagramBuilderSets the page size used by the generated swimlane page.
Parameters
- width System.Double
- height System.Double
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
public VisioSwimlaneDiagramBuilder Phase(String id, String text) #Returns:
VisioSwimlaneDiagramBuilderAdds a vertical phase/milestone column.
Parameters
- id System.String
- text System.String
public VisioSwimlaneDiagramBuilder Start(String id, String text, String laneId, String phaseId) #Returns:
VisioSwimlaneDiagramBuilderAdds a start activity.
Parameters
- id System.String
- text System.String
- laneId System.String
- phaseId System.String
public VisioSwimlaneDiagramBuilder Step(String id, String text, String laneId, String phaseId) #Returns:
VisioSwimlaneDiagramBuilderAdds a process step.
Parameters
- id System.String
- text System.String
- laneId System.String
- phaseId System.String
public VisioSwimlaneDiagramBuilder Theme(VisioStyleTheme theme) #Returns:
VisioSwimlaneDiagramBuilderSets the visual theme.
Parameters
- theme OfficeIMO.Visio.VisioStyleTheme
public VisioSwimlaneDiagramBuilder Title(String text = null, String id = "title", Double height = 0.45, Double gap = 0.35) #Returns:
VisioSwimlaneDiagramBuilderAdds a centered editable title above the generated swimlane grid.
Parameters
- text System.String = null
- id System.String = "title"
- height System.Double = 0.45
- gap System.Double = 0.35