Meziantou.FrameworkEventModelingFrame Class
A frame of an event model: an entity at a point of the timeline, drawn as a box in its swimlane.
public sealed class EventModelingFrameConstructors
| Name | Description |
|---|---|
| EventModelingFrame(string, EventModelingEntityKind, string) | Initializes a new instance of the EventModelingFrame class. |
EventModelingFrame(string, EventModelingEntityKind, string)
EventModelingFrame.csInitializes a new instance of the EventModelingFrame class.
public EventModelingFrame(string id, EventModelingEntityKind kind, string entity)Parameters
idstring- The identifier: one to three digits, unique in the diagram.
kindEventModelingEntityKind- The kind of the entity.
entitystring- The name of the entity, such as
AddItem, orCart.AddItemto put it in the swimlane of the namespaceCart.
Properties
| Name | Description |
|---|---|
| Data | Gets or sets the inline data the box shows, or null for none. It is on one line. |
| DataBlock | Gets or sets the data block whose data the box shows, or null for none. It takes precedence over EventModelingFrame.Data. |
| Entity | Gets or sets the name of the entity. A name of two parts, Namespace.Name, puts the box in the swimlane of the namespace and shows the second part. |
| Id | Gets the identifier of the frame, unique in the diagram. |
| IsReset | Gets or sets a value that indicates whether the frame is a reset frame (Mermaid rf): no relation is inferred from the frames before it. |
| Kind | Gets or sets the kind of the entity, which sets the swimlane and the colors of the box. |
| Sources | Gets the frames this frame receives input from (Mermaid ->>). Without sources, a relation is inferred from the last frame of another swimlane before it, unless the frame is a reset frame. |
Gets or sets the inline data the box shows, or null for none. It is on one line.
public EventModelingData? Data { get; set; }Property value
DataBlock
EventModelingFrame.csGets or sets the data block whose data the box shows, or null for none. It takes precedence over EventModelingFrame.Data.
public EventModelingDataBlock? DataBlock { get; set; }Property value
Entity
EventModelingFrame.csIsReset
EventModelingFrame.csGets or sets the kind of the entity, which sets the swimlane and the colors of the box.
public EventModelingEntityKind Kind { get; set; }Property value
Sources
EventModelingFrame.csGets the frames this frame receives input from (Mermaid ->>). Without sources, a relation is inferred from the last frame of another swimlane before it, unless the frame is a reset frame.
public IList<EventModelingFrame> Sources { get; }Property value
Methods
| Name | Description |
|---|---|
| ToString() | Returns the identifier and the entity of the frame. |