C4Boundary Class

A boundary of a C4 diagram, or a deployment node: a frame with a name around elements and other boundaries.

public sealed class C4Boundary : C4Item
Inheritance
C4Item C4Boundary

Constructors

NameDescription
C4Boundary(string, DiagramText, C4BoundaryKind)Initializes a new instance of the C4Boundary class.

C4Boundary(string, DiagramText, C4BoundaryKind)

C4Boundary.cs

Initializes a new instance of the C4Boundary class.

public C4Boundary(string id, DiagramText label, C4BoundaryKind kind = C4BoundaryKind.Boundary)

Parameters

id string
The identifier (Mermaid alias).
label DiagramText
The name.
kind C4BoundaryKind
The kind.

Properties

NameDescription
BoundariesGets the boundaries nested in this one, placed after the elements.
ElementsGets the elements of the boundary, placed in rows in order.
KindGets or sets the kind of the boundary. A deployment node has a solid frame; the other boundaries are dashed.
TypeGets or sets the type shown between brackets below the name, such as Ubuntu 16.04 LTS for a deployment node, or null for the default: none for a C4BoundaryKind.Boundary, the kind for the others.

Boundaries

C4Boundary.cs

Gets the boundaries nested in this one, placed after the elements.

public IList<C4Boundary> Boundaries { get; }

Property value

IList<C4Boundary>

Gets the elements of the boundary, placed in rows in order.

public IList<C4Element> Elements { get; }

Property value

IList<C4Element>

Gets or sets the kind of the boundary. A deployment node has a solid frame; the other boundaries are dashed.

public C4BoundaryKind Kind { get; set; }

Property value

C4BoundaryKind

Gets or sets the type shown between brackets below the name, such as Ubuntu 16.04 LTS for a deployment node, or null for the default: none for a C4BoundaryKind.Boundary, the kind for the others.

public string? Type { get; set; }

Property value

string?