API Reference
Class
VisioSequenceDiagramBuilder
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.
Returned or exposed by
- Method VisioSequenceDiagramBuilder.Activation
- Method VisioSequenceDiagramBuilder.Activations
- Method VisioSequenceDiagramBuilder.Actor
- Method VisioSequenceDiagramBuilder.Async
- Method VisioSequenceDiagramBuilder.Boundary
- Method VisioSequenceDiagramBuilder.Call
- Method VisioSequenceDiagramBuilder.Control
- Method VisioSequenceDiagramBuilder.Database
- Method VisioSequenceDiagramBuilder.Entity
- Method VisioSequenceDiagramBuilder.Fragment
- Method VisioSequenceDiagramBuilder.Fragment
- Method VisioSequenceDiagramBuilder.FragmentGuard
- Method VisioSequenceDiagramBuilder.FragmentOperands
- Method VisioSequenceDiagramBuilder.FragmentPartition
- Method VisioSequenceDiagramBuilder.Fragments
- Method VisioSequenceDiagramBuilder.Import
- Method VisioSequenceDiagramBuilder.Margins
- Method VisioSequenceDiagramBuilder.Message
- Method VisioSequenceDiagramBuilder.Messages
- Method VisioSequenceDiagramBuilder.NestedFragment
- Method VisioSequenceDiagramBuilder.NestedFragment
- Method VisioSequenceDiagramBuilder.Note
- Method VisioSequenceDiagramBuilder.Notes
- Method VisioSequenceDiagramBuilder.PageSize
- Method VisioSequenceDiagramBuilder.Participant
- Method VisioSequenceDiagramBuilder.Participant
- Method VisioSequenceDiagramBuilder.Participants
- Method VisioSequenceDiagramBuilder.ParticipantSize
- Method VisioSequenceDiagramBuilder.Return
- Method VisioSequenceDiagramBuilder.SelfMessage
- Method VisioSequenceDiagramBuilder.Spacing
- Method VisioSequenceDiagramBuilder.System
- Method VisioSequenceDiagramBuilder.Theme
- Method VisioSequenceDiagramBuilder.Title
Accepted by parameters
- Method VisioSequenceDiagramDocumentExtensions.SequenceDiagram
- Extension method VisioDocument.SequenceDiagram
Methods
public VisioSequenceDiagramBuilder Activation(String participantId, Int32 startRowIndex, Int32 endRowIndex, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds an execution/focus activation bar on a known participant over a range of message rows.
Parameters
- participantId System.String
- startRowIndex System.Int32
- endRowIndex System.Int32
- id System.String = null
public VisioSequenceDiagramBuilder Activations(IEnumerable<VisioSequenceActivationRecord> activations) #Returns:
VisioSequenceDiagramBuilderImports activation records into the sequence diagram.
Parameters
- activations System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceActivationRecord}
public VisioSequenceDiagramBuilder Actor(String id, String text) #Returns:
VisioSequenceDiagramBuilderAdds an actor participant.
Parameters
- id System.String
- text System.String
public VisioSequenceDiagramBuilder Async(String fromId, String toId, String label, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds an asynchronous message.
Parameters
- fromId System.String
- toId System.String
- label System.String
- id System.String = null
public VisioSequenceDiagramBuilder Boundary(String id, String text) #Returns:
VisioSequenceDiagramBuilderAdds a boundary/interface participant.
Parameters
- id System.String
- text System.String
public VisioSequenceDiagramBuilder Call(String fromId, String toId, String label, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a synchronous call message.
Parameters
- fromId System.String
- toId System.String
- label System.String
- id System.String = null
public VisioSequenceDiagramBuilder Control(String id, String text) #Returns:
VisioSequenceDiagramBuilderAdds a control/coordinator participant.
Parameters
- id System.String
- text System.String
public VisioSequenceDiagramBuilder Database(String id, String text) #Returns:
VisioSequenceDiagramBuilderAdds a database participant.
Parameters
- id System.String
- text System.String
public VisioSequenceDiagramBuilder Entity(String id, String text) #Returns:
VisioSequenceDiagramBuilderAdds an entity participant.
Parameters
- id System.String
- text System.String
Fragment 2 overloads
public VisioSequenceDiagramBuilder Fragment(String text, Int32 startRowIndex, Int32 endRowIndex, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a UML combined fragment spanning all known participants over a range of message rows.
Parameters
- text System.String
- startRowIndex System.Int32
- endRowIndex System.Int32
- id System.String = null
public VisioSequenceDiagramBuilder Fragment(String text, Int32 startRowIndex, Int32 endRowIndex, IEnumerable<String> participantIds, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a UML combined fragment spanning selected participants over a range of message rows.
Parameters
- text System.String
- startRowIndex System.Int32
- endRowIndex System.Int32
- participantIds System.Collections.Generic.IEnumerable{System.String}
- id System.String = null
public VisioSequenceDiagramBuilder FragmentGuard(String fragmentId, String text, Int32 rowIndex, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a guard label inside an existing UML combined fragment.
Parameters
- fragmentId System.String
- text System.String
- rowIndex System.Int32
- id System.String = null
public VisioSequenceDiagramBuilder FragmentOperands(IEnumerable<VisioSequenceFragmentOperandRecord> operands) #Returns:
VisioSequenceDiagramBuilderImports fragment guard and partition records into the sequence diagram.
Parameters
- operands System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceFragmentOperandRecord}
public VisioSequenceDiagramBuilder FragmentPartition(String fragmentId, String text, Int32 beforeRowIndex, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds an operand divider and guard label inside an existing UML combined fragment.
Parameters
- fragmentId System.String
- text System.String
- beforeRowIndex System.Int32
- id System.String = null
public VisioSequenceDiagramBuilder Fragments(IEnumerable<VisioSequenceFragmentRecord> fragments) #Returns:
VisioSequenceDiagramBuilderImports combined-fragment records into the sequence diagram.
Parameters
- fragments System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceFragmentRecord}
public VisioSequenceDiagramBuilder Import(IEnumerable<VisioSequenceParticipantRecord> participants, IEnumerable<VisioSequenceMessageRecord> messages, IEnumerable<VisioSequenceActivationRecord> activations = null, IEnumerable<VisioSequenceFragmentRecord> fragments = null, IEnumerable<VisioSequenceFragmentOperandRecord> fragmentOperands = null, IEnumerable<VisioSequenceNoteRecord> notes = null) #Returns:
VisioSequenceDiagramBuilderImports sequence participants, messages, activations, fragments, fragment operands, and notes from simple data records.
Parameters
- participants System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceParticipantRecord}
- messages System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceMessageRecord}
- activations System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceActivationRecord} = null
- fragments System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceFragmentRecord} = null
- fragmentOperands System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceFragmentOperandRecord} = null
- notes System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceNoteRecord} = null
public VisioSequenceDiagramBuilder Margins(Double left, Double top, Double right = 0.85, Double bottom = 0.7) #Returns:
VisioSequenceDiagramBuilderSets outer page margins used by the automatic layout.
Parameters
- left System.Double
- top System.Double
- right System.Double = 0.85
- bottom System.Double = 0.7
public VisioSequenceDiagramBuilder Message(String fromId, String toId, String label, VisioSequenceMessageKind kind = Call, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a message between two known participants.
Parameters
- fromId System.String
- toId System.String
- label System.String
- kind OfficeIMO.Visio.Diagrams.VisioSequenceMessageKind = Call
- id System.String = null
public VisioSequenceDiagramBuilder Messages(IEnumerable<VisioSequenceMessageRecord> messages) #Returns:
VisioSequenceDiagramBuilderImports message records into the sequence diagram.
Parameters
- messages System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceMessageRecord}
NestedFragment 2 overloads
public VisioSequenceDiagramBuilder NestedFragment(String parentFragmentId, String text, Int32 startRowIndex, Int32 endRowIndex, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a nested UML combined fragment inside an existing fragment.
Parameters
- parentFragmentId System.String
- text System.String
- startRowIndex System.Int32
- endRowIndex System.Int32
- id System.String = null
public VisioSequenceDiagramBuilder NestedFragment(String parentFragmentId, String text, Int32 startRowIndex, Int32 endRowIndex, IEnumerable<String> participantIds, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a nested UML combined fragment spanning selected participants inside an existing fragment.
Parameters
- parentFragmentId System.String
- text System.String
- startRowIndex System.Int32
- endRowIndex System.Int32
- participantIds System.Collections.Generic.IEnumerable{System.String}
- id System.String = null
public VisioSequenceDiagramBuilder Note(String participantId, String text, Int32 rowIndex, VisioSide placement = Right, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a semantic note near a participant at a message row.
Parameters
- participantId System.String
- text System.String
- rowIndex System.Int32
- placement OfficeIMO.Visio.VisioSide = Right
- id System.String = null
public VisioSequenceDiagramBuilder Notes(IEnumerable<VisioSequenceNoteRecord> notes) #Returns:
VisioSequenceDiagramBuilderImports semantic note records into the sequence diagram.
Parameters
- notes System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceNoteRecord}
public VisioSequenceDiagramBuilder PageSize(Double width, Double height, VisioMeasurementUnit unit = Inches) #Returns:
VisioSequenceDiagramBuilderSets the page size used by the generated sequence diagram page.
Parameters
- width System.Double
- height System.Double
- unit OfficeIMO.Visio.VisioMeasurementUnit = Inches
Participant 2 overloads
public VisioSequenceDiagramBuilder Participant(String id, String text) #Returns:
VisioSequenceDiagramBuilderAdds a generic participant.
Parameters
- id System.String
- text System.String
public VisioSequenceDiagramBuilder Participant(String id, String text, VisioSequenceParticipantKind kind) #Returns:
VisioSequenceDiagramBuilderAdds a participant with an explicit semantic kind.
Parameters
- id System.String
- text System.String
- kind OfficeIMO.Visio.Diagrams.VisioSequenceParticipantKind
public VisioSequenceDiagramBuilder Participants(IEnumerable<VisioSequenceParticipantRecord> participants) #Returns:
VisioSequenceDiagramBuilderImports participant records into the sequence diagram.
Parameters
- participants System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Diagrams.VisioSequenceParticipantRecord}
public VisioSequenceDiagramBuilder ParticipantSize(Double width, Double height) #Returns:
VisioSequenceDiagramBuilderSets participant header size.
Parameters
- width System.Double
- height System.Double
public VisioSequenceDiagramBuilder Return(String fromId, String toId, String label, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a return/response message.
Parameters
- fromId System.String
- toId System.String
- label System.String
- id System.String = null
public VisioSequenceDiagramBuilder SelfMessage(String participantId, String label, VisioSequenceMessageKind kind = Call, String id = null) #Returns:
VisioSequenceDiagramBuilderAdds a self-message loop on a known participant.
Parameters
- participantId System.String
- label System.String
- kind OfficeIMO.Visio.Diagrams.VisioSequenceMessageKind = Call
- id System.String = null
public VisioSequenceDiagramBuilder Spacing(Double participantGap = 1.15, Double messageSpacing = 0.62, Double messageGap = 0.55) #Returns:
VisioSequenceDiagramBuilderSets participant and message spacing.
Parameters
- participantGap System.Double = 1.15
- messageSpacing System.Double = 0.62
- messageGap System.Double = 0.55
public VisioSequenceDiagramBuilder System(String id, String text) #Returns:
VisioSequenceDiagramBuilderAdds a system/service participant.
Parameters
- id System.String
- text System.String
public VisioSequenceDiagramBuilder Theme(VisioStyleTheme theme) #Returns:
VisioSequenceDiagramBuilderSets the visual theme.
Parameters
- theme OfficeIMO.Visio.VisioStyleTheme
public VisioSequenceDiagramBuilder Title(String text = null, String id = "title", Double height = 0.45, Double gap = 0.35) #Returns:
VisioSequenceDiagramBuilderAdds a centered editable title above the generated sequence diagram.
Parameters
- text System.String = null
- id System.String = "title"
- height System.Double = 0.45
- gap System.Double = 0.35
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object