Class ActivityDialogSpec

Namespace

ItTiger.TigerCli.Tui.Activity

Assembly

ItTiger.TigerCli.dll

Immutable description of a rich activity dialog's live layout: variable columns and rows of cells, with named dynamic rows carrying fixed-length value arrays. Build one with Create(); the activity control maps it (plus the runtime values) onto a CliGrid. The spec is shape only — runtime values are held separately and mutated through the operation's activity context.

public sealed class ActivityDialogSpec

Inheritance

object

ActivityDialogSpec

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Columns

The column definitions, left to right.

public IReadOnlyList<ActivityColumnSpec> Columns { get; }

Property Value

IReadOnlyList<ActivityColumnSpec>

DefaultCellAlignment

Optional spec-wide default horizontal alignment for text cells, applied when neither the text element nor its column declares an alignment. null means fall back to the built-in default.

public CliTextAlignment? DefaultCellAlignment { get; }

Property Value

CliTextAlignment?

DefaultCellStyle

Optional spec-wide default theme style for text cells, applied when neither the text element nor its column declares a style. null means fall back to the built-in default.

public ThemeStyle? DefaultCellStyle { get; }

Property Value

ThemeStyle?

NonInteractiveMessage

Optional one-line message printed once (to stdout, via TigerConsole.MarkupLine) before the operation body runs when the activity is executed in NonInteractive mode. It gives scripts a single line of progress context in place of the live dialog. It is never used in interactive mode (the dialog is shown instead), and null/empty prints nothing. Like activity text templates it is a trusted markup template (may contain TigerCli markup).

public string? NonInteractiveMessage { get; }

Property Value

string

Rows

The row definitions, top to bottom.

public IReadOnlyList<ActivityRowSpec> Rows { get; }

Property Value

IReadOnlyList<ActivityRowSpec>

Methods

Create()

Starts a new fluent activity specification.

public static ActivitySpecBuilder Create()

Returns

ActivitySpecBuilder

GetRow(string)

The dynamic row with the given name, or null when none exists.

public ActivityRowSpec? GetRow(string name)

Parameters

name string

Returns

ActivityRowSpec