API Reference

Class

VisioSequenceDiagramBuilder

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

High-level builder for UML-style sequence diagrams with deterministic participant, lifeline, and message placement.

Inheritance

  • Object
  • VisioSequenceDiagramBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

public VisioSequenceDiagramBuilder Actor(String id, String text) #
Returns: VisioSequenceDiagramBuilder

Adds an actor participant.

Parameters

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

Adds an asynchronous message.

Parameters

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

Adds a boundary/interface participant.

Parameters

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

Adds a synchronous call message.

Parameters

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

Adds a control/coordinator participant.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioSequenceDiagramBuilder Database(String id, String text) #
Returns: VisioSequenceDiagramBuilder

Adds a database participant.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioSequenceDiagramBuilder Entity(String id, String text) #
Returns: VisioSequenceDiagramBuilder

Adds an entity participant.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioSequenceDiagramBuilder Margins(Double left, Double top, Double right = 0.85, Double bottom = 0.7) #
Returns: VisioSequenceDiagramBuilder

Sets outer page margins used by the automatic layout.

Parameters

left System.Double requiredposition: 0
top System.Double requiredposition: 1
right System.Double = 0.85 optionalposition: 2
bottom System.Double = 0.7 optionalposition: 3
public VisioSequenceDiagramBuilder Message(String fromId, String toId, String label, VisioSequenceMessageKind kind = Call, String id = null) #
Returns: VisioSequenceDiagramBuilder

Adds a message between two known participants.

Parameters

fromId System.String requiredposition: 0
toId System.String requiredposition: 1
label System.String requiredposition: 2
kind OfficeIMO.Visio.Diagrams.VisioSequenceMessageKind = Call optionalposition: 3
id System.String = null optionalposition: 4
public VisioSequenceDiagramBuilder PageSize(Double width, Double height, VisioMeasurementUnit unit = Inches) #
Returns: VisioSequenceDiagramBuilder

Sets the page size used by the generated sequence diagram page.

Parameters

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

Adds a generic participant.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
public VisioSequenceDiagramBuilder Participant(String id, String text, VisioSequenceParticipantKind kind) #
Returns: VisioSequenceDiagramBuilder

Adds a participant with an explicit semantic kind.

Parameters

id System.String requiredposition: 0
text System.String requiredposition: 1
kind OfficeIMO.Visio.Diagrams.VisioSequenceParticipantKind requiredposition: 2
public VisioSequenceDiagramBuilder ParticipantSize(Double width, Double height) #
Returns: VisioSequenceDiagramBuilder

Sets participant header size.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
public VisioSequenceDiagramBuilder Return(String fromId, String toId, String label, String id = null) #
Returns: VisioSequenceDiagramBuilder

Adds a return/response message.

Parameters

fromId System.String requiredposition: 0
toId System.String requiredposition: 1
label System.String requiredposition: 2
id System.String = null optionalposition: 3
public VisioSequenceDiagramBuilder SelfMessage(String participantId, String label, VisioSequenceMessageKind kind = Call, String id = null) #
Returns: VisioSequenceDiagramBuilder

Adds a self-message loop on a known participant.

Parameters

participantId System.String requiredposition: 0
label System.String requiredposition: 1
kind OfficeIMO.Visio.Diagrams.VisioSequenceMessageKind = Call optionalposition: 2
id System.String = null optionalposition: 3
public VisioSequenceDiagramBuilder Spacing(Double participantGap = 1.15, Double messageSpacing = 0.62, Double messageGap = 0.55) #
Returns: VisioSequenceDiagramBuilder

Sets participant and message spacing.

Parameters

participantGap System.Double = 1.15 optionalposition: 0
messageSpacing System.Double = 0.62 optionalposition: 1
messageGap System.Double = 0.55 optionalposition: 2
public VisioSequenceDiagramBuilder System(String id, String text) #
Returns: VisioSequenceDiagramBuilder

Adds a system/service participant.

Parameters

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

Sets the visual theme.

Parameters

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

Adds a centered editable title above the generated sequence diagram.

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