Table of Contents

Class ComponentView

Namespace
C4.Net
Assembly
C4.Net.Core.dll

A component view that shows components inside a container and their direct neighbours.

[DataContract]
public sealed class ComponentView : StaticView
Inheritance
ComponentView
Inherited Members

Properties

Container

References the container whose components are in scope for this view.

public Container Container { get; set; }

Property Value

Container

ContainerId

The ID of the container this view is associated with.

[DataMember(Name = "containerId", EmitDefaultValue = false)]
public string ContainerId { get; set; }

Property Value

string

ExternalContainerBoundariesVisible

Determines whether container boundaries should be visible for "external" components (those outside the container in scope).

[DataMember(Name = "externalContainerBoundariesVisible", EmitDefaultValue = false)]
public bool? ExternalContainerBoundariesVisible { get; set; }

Property Value

bool?

Name

Returns the default name shown for this component view.

public override string Name { get; }

Property Value

string

Methods

Add(Component)

Adds a component to the view.

public void Add(Component component)

Parameters

component Component

The component to add.

Add(Container)

Adds a container to the component view.

public void Add(Container container)

Parameters

container Container

The container to add.

AddAllComponents()

Adds every component defined inside the scoped container.

public void AddAllComponents()

AddAllContainers()

Adds every container in the scoped software system except the container already in scope.

public void AddAllContainers()

AddAllElements()

Adds all people, software systems, containers, and components permitted by this view.

public override void AddAllElements()

AddDefaultElements()

Adds the default set of elements to this view.

public override void AddDefaultElements()

AddNearestNeighbours(Element)

Adds people, software systems, containers and components that are directly related to the given element.

public override void AddNearestNeighbours(Element element)

Parameters

element Element

CheckElementCanBeAdded(Element) 

protected override void CheckElementCanBeAdded(Element element)

Parameters

element Element

Remove(Component)

Removes a component from the view.

public void Remove(Component component)

Parameters

component Component

The component to remove.

Remove(Container)

Removes a container from the component view.

public void Remove(Container container)

Parameters

container Container

The container to remove.