Skip to content
ConsoleMonster
Class

DiagramUseCase

ConsoleMonster.Widgets

Edit on GitHub
Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Source
DiagramModels.cs:140
Modifiers
sealed

A sequence of interactions that can be stepped or played.

Inheritance

  • object
  • DiagramUseCase

Usage

Explore 36 API references to this type

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

Returned or exposed by 16

Accepted by parameters 20

Constructors

public DiagramUseCase(string label) #
DiagramModels.cs:140

Creates a use case.

Parameters

label string required

Properties

public string Id { get; set; } #
DiagramModels.cs:136

The selection key; defaults to Label.

public string Label { get; set; } #
DiagramModels.cs:138

The use case's name.

public List<DiagramStep> Steps { get; } #
DiagramModels.cs:140

The ordered interactions.

public int Delay { get; set; } #
DiagramModels.cs:142

The playback interval in milliseconds.

public bool Loop { get; set; } #
DiagramModels.cs:144

Whether playback repeats.

public bool AutoPlay { get; set; } #
DiagramModels.cs:146

Whether playback starts when the keyboard view opens.

Extension Methods

public static DiagramUseCase AddStep(DiagramUseCase diagramUseCase, DiagramStep item) #

Adds an item to DiagramUseCase.Steps: The ordered interactions.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance.
item ConsoleMonster.Widgets.DiagramStep required
The item.

Returns

DiagramUseCase The same instance.
AddSteps 2 overloads
public static DiagramUseCase AddSteps(DiagramUseCase diagramUseCase, params DiagramStep[] items) #

Adds items to DiagramUseCase.Steps: The ordered interactions.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance.
items ConsoleMonster.Widgets.DiagramStep[] required
The items, in order.

Returns

DiagramUseCase The same instance.
public static DiagramUseCase AddSteps(DiagramUseCase diagramUseCase, IEnumerable<DiagramStep> items) #

Adds items to DiagramUseCase.Steps: The ordered interactions.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.DiagramStep> required
The items, in order.

Returns

DiagramUseCase The same instance.
AutoPlay 2 overloads
public static DiagramUseCase AutoPlay(DiagramUseCase diagramUseCase, bool value) #

Sets DiagramUseCase.AutoPlay: Whether playback starts when the keyboard view opens.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance.
value bool required
The value.

Returns

DiagramUseCase The same instance.

Examples

// C# initializer or property       // C# fluent
diagramUseCase.AutoPlay = value;    diagramUseCase.AutoPlay(value);
public static DiagramUseCase AutoPlay(DiagramUseCase diagramUseCase) #

Sets DiagramUseCase.AutoPlay to true.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance to configure.

Returns

DiagramUseCase The same instance.
public static DiagramUseCase Delay(DiagramUseCase diagramUseCase, int value) #

Sets DiagramUseCase.Delay: The playback interval in milliseconds.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance.
value int required
The value.

Returns

DiagramUseCase The same instance.

Examples

// C# initializer or property    // C# fluent
diagramUseCase.Delay = value;    diagramUseCase.Delay(value);
public static DiagramUseCase Id(DiagramUseCase diagramUseCase, string value) #

Sets DiagramUseCase.Id: The selection key; defaults to Label.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance.
value string required
The value.

Returns

DiagramUseCase The same instance.

Examples

// C# initializer or property    // C# fluent
diagramUseCase.Id = value;       diagramUseCase.Id(value);
public static DiagramUseCase Label(DiagramUseCase diagramUseCase, string value) #

Sets DiagramUseCase.Label: The use case's name.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance.
value string required
The value.

Returns

DiagramUseCase The same instance.

Examples

// C# initializer or property    // C# fluent
diagramUseCase.Label = value;    diagramUseCase.Label(value);
Loop 2 overloads
public static DiagramUseCase Loop(DiagramUseCase diagramUseCase, bool value) #

Sets DiagramUseCase.Loop: Whether playback repeats.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance.
value bool required
The value.

Returns

DiagramUseCase The same instance.

Examples

// C# initializer or property    // C# fluent
diagramUseCase.Loop = value;     diagramUseCase.Loop(value);
public static DiagramUseCase Loop(DiagramUseCase diagramUseCase) #

Sets DiagramUseCase.Loop to true.

Parameters

diagramUseCase ConsoleMonster.Widgets.DiagramUseCase required
The instance to configure.

Returns

DiagramUseCase The same instance.